ReadonlyconnectionsThe network connections associated with this resource.
ReadonlyenvThe environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
ReadonlyidThe ID of the construct with the App suffix.
This should be used in place of id when trying to reference the construct.
Optional ReadonlyipThe IP Address Type for this load balancer
If the @aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault
feature flag is set (the default for new projects), and addListener() is called with open: true,
the load balancer's security group will automatically include both IPv4 and IPv6 ingress rules
when using IpAddressType.DUAL_STACK_WITHOUT_PUBLIC_IPV4.
For existing projects that only have IPv4 rules, you can opt-in to IPv6 ingress rules by enabling the feature flag in your cdk.json file. Note that enabling this feature flag will modify existing security group rules.
ReadonlylistenersA list of listeners that have been added to the load balancer. This list is only valid for owned constructs.
ReadonlyloadThe ARN of this load balancer
Example value: arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188
ReadonlyloadThe canonical hosted zone ID of this load balancer
Example value: Z2P70J7EXAMPLE
ReadonlyloadThe DNS name of this load balancer
Example value: my-load-balancer-424835706.us-west-2.elb.amazonaws.com
ReadonlyloadThe full name of this load balancer
Example value: app/my-load-balancer/50dc6c495c0c9188
ReadonlyloadThe name of this load balancer
Example value: my-load-balancer
ReadonlyloadReadonlymetricsAll metrics available for this load balancer
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlystackThe stack in which this resource is defined.
Optional ReadonlyvpcThe VPC this load balancer has been created in.
This property is always defined (not null or undefined) for sub-classes of BaseLoadBalancer.
Static ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Add a new listener to this load balancer
Add a redirection listener to this load balancer
Optionalprops: ApplicationLoadBalancerRedirectConfigAdd a security group to this load balancer
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Enable access logging for this load balancer.
A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html
Optionalprefix: stringEnable connection logging for this load balancer.
A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks.
Optionalprefix: stringThe number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
Optionalprops: MetricOptionsThe number of user authentications that could not be completed
Because an authenticate action was misconfigured, the load balancer couldn't establish a connection with the IdP, or the load balancer couldn't complete the authentication flow due to an internal error.
Optionalprops: MetricOptionsThe number of user authentications that could not be completed because the IdP denied access to the user or an authorization code was used more than once.
Optionalprops: MetricOptionsThe time elapsed, in milliseconds, to query the IdP for the ID token and user info.
If one or more of these operations fail, this is the time to failure.
Optionalprops: MetricOptionsThe number of authenticate actions that were successful.
This metric is incremented at the end of the authentication workflow, after the load balancer has retrieved the user claims from the IdP.
Optionalprops: MetricOptionsThe number of HTTP 3xx/4xx/5xx codes that originate from the load balancer.
This does not include any response codes generated by the targets.
Optionalprops: MetricOptionsThe number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in the load balancer.
This does not include any response codes generated by the load balancer.
Optionalprops: MetricOptionsThe number of TLS connections initiated by the load balancer that did not establish a session with the target.
Possible causes include a mismatch of ciphers or protocols.
Optionalprops: MetricOptionsRemove an attribute from the load balancer
ProtectedresourceSet a non-standard attribute on the load balancer
Returns a string representation of an object.
ProtectedvalidateProtected Static_InternalQueries the load balancer context provider for load balancer info.
StaticfromStaticfromStaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
Construct which creates an Application Load Balancer.
This construct should be used in conjunction with [[
GuApplicationListener]] and [[GuApplicationTargetGroup]] to route traffic to your application. For more details on these three components, see the AWS documentation.This resource is stateful.
See
https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md