class CfnLoadBalancer (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ElasticLoadBalancingV2.CfnLoadBalancer |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#CfnLoadBalancer |
![]() | software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer |
![]() | aws_cdk.aws_elasticloadbalancingv2.CfnLoadBalancer |
![]() | aws-cdk-lib » aws_elasticloadbalancingv2 » CfnLoadBalancer |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
const cfnLoadBalancer = new elbv2.CfnLoadBalancer(this, 'MyCfnLoadBalancer', /* all optional props */ {
enablePrefixForIpv6SourceNat: 'enablePrefixForIpv6SourceNat',
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: 'enforceSecurityGroupInboundRulesOnPrivateLinkTraffic',
ipAddressType: 'ipAddressType',
loadBalancerAttributes: [{
key: 'key',
value: 'value',
}],
minimumLoadBalancerCapacity: {
capacityUnits: 123,
},
name: 'name',
scheme: 'scheme',
securityGroups: ['securityGroups'],
subnetMappings: [{
subnetId: 'subnetId',
// the properties below are optional
allocationId: 'allocationId',
iPv6Address: 'iPv6Address',
privateIPv4Address: 'privateIPv4Address',
sourceNatIpv6Prefix: 'sourceNatIpv6Prefix',
}],
subnets: ['subnets'],
tags: [{
key: 'key',
value: 'value',
}],
type: 'type',
});
Initializer
new CfnLoadBalancer(scope: Construct, id: string, props?: CfnLoadBalancerProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Load Balancer Props
Construct Props
Name | Type | Description |
---|---|---|
enable | string | [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. |
enforce | string | Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink . |
ip | string | The IP address type. Internal load balancers must use ipv4 . |
load | IResolvable | IResolvable | Load [] | The load balancer attributes. |
minimum | IResolvable | Minimum | The minimum capacity for a load balancer. |
name? | string | The name of the load balancer. |
scheme? | string | The nodes of an Internet-facing load balancer have public IP addresses. |
security | string[] | [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
subnet | IResolvable | IResolvable | Subnet [] | The IDs of the subnets. |
subnets? | string[] | The IDs of the subnets. |
tags? | Cfn [] | The tags to assign to the load balancer. |
type? | string | The type of load balancer. |
enablePrefixForIpv6SourceNat?
Type:
string
(optional)
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
The IP address type must be dualstack
. The default value is off
.
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic?
Type:
string
(optional)
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .
The default is on
.
ipAddressType?
Type:
string
(optional)
The IP address type. Internal load balancers must use ipv4
.
[Application Load Balancers] The possible values are ipv4
(IPv4 addresses), dualstack
(IPv4 and IPv6 addresses), and dualstack-without-public-ipv4
(public IPv6 addresses and private IPv4 and IPv6 addresses).
Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4
(IPv4 addresses) and dualstack
(IPv4 and IPv6 addresses).
loadBalancerAttributes?
Type:
IResolvable
|
IResolvable
|
Load
[]
(optional)
The load balancer attributes.
minimumLoadBalancerCapacity?
Type:
IResolvable
|
Minimum
(optional)
The minimum capacity for a load balancer.
name?
Type:
string
(optional)
The name of the load balancer.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
scheme?
Type:
string
(optional)
The nodes of an Internet-facing load balancer have public IP addresses.
The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You can't specify a scheme for a Gateway Load Balancer.
securityGroups?
Type:
string[]
(optional)
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
subnetMappings?
Type:
IResolvable
|
IResolvable
|
Subnet
[]
(optional)
The IDs of the subnets.
You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
subnets?
Type:
string[]
(optional)
The IDs of the subnets.
You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
tags?
Type:
Cfn
[]
(optional)
The tags to assign to the load balancer.
type?
Type:
string
(optional)
The type of load balancer.
The default is application
.
Properties
Name | Type | Description |
---|---|---|
attr | string | The ID of the Amazon Route 53 hosted zone associated with the load balancer. |
attr | string | The DNS name for the load balancer. |
attr | string | The Amazon Resource Name (ARN) of the load balancer. |
attr | string | The full name of the load balancer. |
attr | string | The name of the load balancer. |
attr | string[] | The IDs of the security groups for the load balancer. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
enable | string | [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. |
enforce | string | Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink . |
ip | string | The IP address type. |
load | IResolvable | IResolvable | Load [] | The load balancer attributes. |
minimum | IResolvable | Minimum | The minimum capacity for a load balancer. |
name? | string | The name of the load balancer. |
scheme? | string | The nodes of an Internet-facing load balancer have public IP addresses. |
security | string[] | [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. |
subnet | IResolvable | IResolvable | Subnet [] | The IDs of the subnets. |
subnets? | string[] | The IDs of the subnets. |
tags | Cfn [] | The tags to assign to the load balancer. |
type? | string | The type of load balancer. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrCanonicalHostedZoneId
Type:
string
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
For example, Z2P70J7EXAMPLE
.
attrDnsName
Type:
string
The DNS name for the load balancer.
For example, my-load-balancer-424835706.us-west-2.elb.amazonaws.com
.
attrLoadBalancerArn
Type:
string
The Amazon Resource Name (ARN) of the load balancer.
attrLoadBalancerFullName
Type:
string
The full name of the load balancer.
For example, app/my-load-balancer/50dc6c495c0c9188
.
attrLoadBalancerName
Type:
string
The name of the load balancer.
For example, my-load-balancer
.
attrSecurityGroups
Type:
string[]
The IDs of the security groups for the load balancer.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
enablePrefixForIpv6SourceNat?
Type:
string
(optional)
[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic?
Type:
string
(optional)
Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink .
ipAddressType?
Type:
string
(optional)
The IP address type.
Internal load balancers must use ipv4
.
loadBalancerAttributes?
Type:
IResolvable
|
IResolvable
|
Load
[]
(optional)
The load balancer attributes.
minimumLoadBalancerCapacity?
Type:
IResolvable
|
Minimum
(optional)
The minimum capacity for a load balancer.
name?
Type:
string
(optional)
The name of the load balancer.
scheme?
Type:
string
(optional)
The nodes of an Internet-facing load balancer have public IP addresses.
securityGroups?
Type:
string[]
(optional)
[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
subnetMappings?
Type:
IResolvable
|
IResolvable
|
Subnet
[]
(optional)
The IDs of the subnets.
subnets?
Type:
string[]
(optional)
The IDs of the subnets.
tagsRaw?
Type:
Cfn
[]
(optional)
The tags to assign to the load balancer.
type?
Type:
string
(optional)
The type of load balancer.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }