CfnTargetGroup L1 construct
Specifies a target group for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Before you register a Lambda function as a target, you must create a AWS::Lambda::Permission resource that grants the Elastic Load Balancing service principal permission to invoke the Lambda function.
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 cfnTargetGroup = new elbv2.CfnTargetGroup(this, 'MyCfnTargetGroup', /* all optional props */ {
healthCheckEnabled: false,
healthCheckIntervalSeconds: 123,
healthCheckPath: 'healthCheckPath',
healthCheckPort: 'healthCheckPort',
healthCheckProtocol: 'healthCheckProtocol',
healthCheckTimeoutSeconds: 123,
healthyThresholdCount: 123,
ipAddressType: 'ipAddressType',
matcher: {
grpcCode: 'grpcCode',
httpCode: 'httpCode',
},
name: 'name',
port: 123,
protocol: 'protocol',
protocolVersion: 'protocolVersion',
tags: [{
key: 'key',
value: 'value',
}],
targetControlPort: 123,
targetGroupAttributes: [{
key: 'key',
value: 'value',
}],
targets: [{
id: 'id',
// the properties below are optional
availabilityZone: 'availabilityZone',
port: 123,
quicServerId: 'quicServerId',
}],
targetType: 'targetType',
unhealthyThresholdCount: 123,
vpcId: 'vpcId',
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticloadbalancingv2 as elbv2
cfn_target_group = elbv2.CfnTargetGroup(self, "MyCfnTargetGroup",
health_check_enabled=False,
health_check_interval_seconds=123,
health_check_path="healthCheckPath",
health_check_port="healthCheckPort",
health_check_protocol="healthCheckProtocol",
health_check_timeout_seconds=123,
healthy_threshold_count=123,
ip_address_type="ipAddressType",
matcher=elbv2.CfnTargetGroup.MatcherProperty(
grpc_code="grpcCode",
http_code="httpCode"
),
name="name",
port=123,
protocol="protocol",
protocol_version="protocolVersion",
tags=[CfnTag(
key="key",
value="value"
)],
target_control_port=123,
target_group_attributes=[elbv2.CfnTargetGroup.TargetGroupAttributeProperty(
key="key",
value="value"
)],
targets=[elbv2.CfnTargetGroup.TargetDescriptionProperty(
id="id",
# the properties below are optional
availability_zone="availabilityZone",
port=123,
quic_server_id="quicServerId"
)],
target_type="targetType",
unhealthy_threshold_count=123,
vpc_id="vpcId"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticloadbalancingv2.*;
CfnTargetGroup cfnTargetGroup = CfnTargetGroup.Builder.create(this, "MyCfnTargetGroup")
.healthCheckEnabled(false)
.healthCheckIntervalSeconds(123)
.healthCheckPath("healthCheckPath")
.healthCheckPort("healthCheckPort")
.healthCheckProtocol("healthCheckProtocol")
.healthCheckTimeoutSeconds(123)
.healthyThresholdCount(123)
.ipAddressType("ipAddressType")
.matcher(MatcherProperty.builder()
.grpcCode("grpcCode")
.httpCode("httpCode")
.build())
.name("name")
.port(123)
.protocol("protocol")
.protocolVersion("protocolVersion")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.targetControlPort(123)
.targetGroupAttributes(List.of(TargetGroupAttributeProperty.builder()
.key("key")
.value("value")
.build()))
.targets(List.of(TargetDescriptionProperty.builder()
.id("id")
// the properties below are optional
.availabilityZone("availabilityZone")
.port(123)
.quicServerId("quicServerId")
.build()))
.targetType("targetType")
.unhealthyThresholdCount(123)
.vpcId("vpcId")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
var cfnTargetGroup = new CfnTargetGroup(this, "MyCfnTargetGroup", new CfnTargetGroupProps {
HealthCheckEnabled = false,
HealthCheckIntervalSeconds = 123,
HealthCheckPath = "healthCheckPath",
HealthCheckPort = "healthCheckPort",
HealthCheckProtocol = "healthCheckProtocol",
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
IpAddressType = "ipAddressType",
Matcher = new MatcherProperty {
GrpcCode = "grpcCode",
HttpCode = "httpCode"
},
Name = "name",
Port = 123,
Protocol = "protocol",
ProtocolVersion = "protocolVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TargetControlPort = 123,
TargetGroupAttributes = new [] { new TargetGroupAttributeProperty {
Key = "key",
Value = "value"
} },
Targets = new [] { new TargetDescriptionProperty {
Id = "id",
// the properties below are optional
AvailabilityZone = "availabilityZone",
Port = 123,
QuicServerId = "quicServerId"
} },
TargetType = "targetType",
UnhealthyThresholdCount = 123,
VpcId = "vpcId"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnTargetGroup := awscdk.Aws_elasticloadbalancingv2.NewCfnTargetGroup(this, jsii.String("MyCfnTargetGroup"), &CfnTargetGroupProps{
HealthCheckEnabled: jsii.Boolean(false),
HealthCheckIntervalSeconds: jsii.Number(123),
HealthCheckPath: jsii.String("healthCheckPath"),
HealthCheckPort: jsii.String("healthCheckPort"),
HealthCheckProtocol: jsii.String("healthCheckProtocol"),
HealthCheckTimeoutSeconds: jsii.Number(123),
HealthyThresholdCount: jsii.Number(123),
IpAddressType: jsii.String("ipAddressType"),
Matcher: &MatcherProperty{
GrpcCode: jsii.String("grpcCode"),
HttpCode: jsii.String("httpCode"),
},
Name: jsii.String("name"),
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
ProtocolVersion: jsii.String("protocolVersion"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TargetControlPort: jsii.Number(123),
TargetGroupAttributes: []interface{}{
&TargetGroupAttributeProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Targets: []interface{}{
&TargetDescriptionProperty{
Id: jsii.String("id"),
// the properties below are optional
AvailabilityZone: jsii.String("availabilityZone"),
Port: jsii.Number(123),
QuicServerId: jsii.String("quicServerId"),
},
},
TargetType: jsii.String("targetType"),
UnhealthyThresholdCount: jsii.Number(123),
VpcId: jsii.String("vpcId"),
})
Initializer
new CfnTargetGroup(scope: Construct, id: string, props?: CfnTargetGroupProps)
CfnTargetGroup(scope: Construct, id: str, props: typing.Optional[CfnTargetGroupProps] = None)
new CfnTargetGroup(Construct scope, String id, CfnTargetGroupProps props)
new CfnTargetGroup(Construct scope, string id, CfnTargetGroupProps? props = null)
NewCfnTargetGroup(Scope Construct, Id *string, Props CfnTargetGroupProps)
Construct Props
healthCheckEnabledoptionalboolean | IResolvablehealth_check_enabledoptionaltyping.Union[bool, IResolvable]healthCheckEnabledoptionalBooleanHealthCheckEnabledoptionalboolHealthCheckEnabledoptionalinterface{}#If the target type is lambda , health checks are disabled by default but can be enabled. If the target type is instance , ip , or alb , health checks are always enabled and can't be disabled.
healthCheckIntervalSecondsoptionalnumberhealth_check_interval_secondsoptionalint | floathealthCheckIntervalSecondsoptionalNumberHealthCheckIntervalSecondsoptionaldoubleHealthCheckIntervalSecondsoptional*float64#notes
The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda , the default is 35 seconds.
healthCheckPathoptionalstringhealth_check_pathoptionalstrhealthCheckPathoptionalStringHealthCheckPathoptionalstringHealthCheckPathoptional*string#[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is / AWS .ALB/healthcheck.
healthCheckPortoptionalstringhealth_check_portoptionalstrhealthCheckPortoptionalStringHealthCheckPortoptionalstringHealthCheckPortoptional*string#If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC the default is traffic-port , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.
healthCheckProtocoloptionalstringhealth_check_protocoloptionalstrhealthCheckProtocoloptionalStringHealthCheckProtocoloptionalstringHealthCheckProtocoloptional*string#notes
For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.
healthCheckTimeoutSecondsoptionalnumberhealth_check_timeout_secondsoptionalint | floathealthCheckTimeoutSecondsoptionalNumberHealthCheckTimeoutSecondsoptionaldoubleHealthCheckTimeoutSecondsoptional*float64#notes
The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda , the default is 30 seconds.
healthyThresholdCountoptionalnumberhealthy_threshold_countoptionalint | floathealthyThresholdCountoptionalNumberHealthyThresholdCountoptionaldoubleHealthyThresholdCountoptional*float64#The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda , the default is 5.
ipAddressTypeoptionalstringip_address_typeoptionalstripAddressTypeoptionalStringIpAddressTypeoptionalstringIpAddressTypeoptional*string#The default value is ipv4 .
matcheroptionalIResolvable | CfnTargetGroup.MatcherPropertymatcheroptionaltyping.Union[IResolvable, MatcherProperty]matcheroptionalIResolvableMatcheroptionalIResolvableMatcheroptionalinterface{}#notes
For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
protocoloptionalstringprotocoloptionalstrprotocoloptionalStringProtocoloptionalstringProtocoloptional*string#notes
For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.
protocolVersionoptionalstringprotocol_versionoptionalstrprotocolVersionoptionalStringProtocolVersionoptionalstringProtocolVersionoptional*string#The possible values are GRPC , HTTP1 , and HTTP2 .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#targetControlPortoptionalnumbertarget_control_portoptionalint | floattargetControlPortoptionalNumberTargetControlPortoptionaldoubleTargetControlPortoptional*float64#targetGroupAttributesoptionalIResolvable | IResolvable | CfnTargetGroup.TargetGroupAttributeProperty[]target_group_attributesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetGroupAttributeProperty]]]targetGroupAttributesoptionalIResolvableTargetGroupAttributesoptionalIResolvableTargetGroupAttributesoptionalinterface{}#Attributes that you do not modify retain their current values.
targetsoptionalIResolvable | IResolvable | CfnTargetGroup.TargetDescriptionProperty[]targetsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetDescriptionProperty]]]targetsoptionalIResolvableTargetsoptionalIResolvableTargetsoptionalinterface{}#targetTypeoptionalstringtarget_typeoptionalstrtargetTypeoptionalStringTargetTypeoptionalstringTargetTypeoptional*string#notes
You can't specify targets for a target group using more than one target type.
instance- Register targets by instance ID. This is the default value.ip- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.lambda- Register a single Lambda function as a target.alb- Register a single Application Load Balancer as a target.
unhealthyThresholdCountoptionalnumberunhealthy_threshold_countoptionalint | floatunhealthyThresholdCountoptionalNumberUnhealthyThresholdCountoptionaldoubleUnhealthyThresholdCountoptional*float64#The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda , the default is 5.
Properties
attrLoadBalancerArnsstring[]attr_load_balancer_arnstyping.List[str]attrLoadBalancerArnsList<String>AttrLoadBalancerArnsstring[]AttrLoadBalancerArns*[]*string#attrTargetGroupArnstringattr_target_group_arnstrattrTargetGroupArnStringAttrTargetGroupArnstringAttrTargetGroupArn*string#attrTargetGroupFullNamestringattr_target_group_full_namestrattrTargetGroupFullNameStringAttrTargetGroupFullNamestringAttrTargetGroupFullName*string#For example, targetgroup/my-target-group/cbf133c568e0d028 .
attrTargetGroupNamestringattr_target_group_namestrattrTargetGroupNameStringAttrTargetGroupNamestringAttrTargetGroupName*string#For example, my-target-group .
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#healthCheckEnabledmay be undefinedboolean | IResolvablehealth_check_enabledmay be undefinedtyping.Union[bool, IResolvable]healthCheckEnabledmay be undefinedBooleanHealthCheckEnabledmay be undefinedboolHealthCheckEnabledmay be undefinedinterface{}#healthCheckIntervalSecondsmay be undefinednumberhealth_check_interval_secondsmay be undefinedint | floathealthCheckIntervalSecondsmay be undefinedNumberHealthCheckIntervalSecondsmay be undefineddoubleHealthCheckIntervalSecondsmay be undefined*float64#healthCheckPathmay be undefinedstringhealth_check_pathmay be undefinedstrhealthCheckPathmay be undefinedStringHealthCheckPathmay be undefinedstringHealthCheckPathmay be undefined*string#healthCheckPortmay be undefinedstringhealth_check_portmay be undefinedstrhealthCheckPortmay be undefinedStringHealthCheckPortmay be undefinedstringHealthCheckPortmay be undefined*string#healthCheckProtocolmay be undefinedstringhealth_check_protocolmay be undefinedstrhealthCheckProtocolmay be undefinedStringHealthCheckProtocolmay be undefinedstringHealthCheckProtocolmay be undefined*string#healthCheckTimeoutSecondsmay be undefinednumberhealth_check_timeout_secondsmay be undefinedint | floathealthCheckTimeoutSecondsmay be undefinedNumberHealthCheckTimeoutSecondsmay be undefineddoubleHealthCheckTimeoutSecondsmay be undefined*float64#healthyThresholdCountmay be undefinednumberhealthy_threshold_countmay be undefinedint | floathealthyThresholdCountmay be undefinedNumberHealthyThresholdCountmay be undefineddoubleHealthyThresholdCountmay be undefined*float64#ipAddressTypemay be undefinedstringip_address_typemay be undefinedstripAddressTypemay be undefinedStringIpAddressTypemay be undefinedstringIpAddressTypemay be undefined*string#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).
matchermay be undefinedIResolvable | CfnTargetGroup.MatcherPropertymatchermay be undefinedtyping.Union[IResolvable, MatcherProperty]matchermay be undefinedIResolvableMatchermay be undefinedIResolvableMatchermay be undefinedinterface{}#namemay be undefinedstringnamemay be undefinedstrnamemay be undefinedStringNamemay be undefinedstringNamemay be undefined*string#portmay be undefinednumberportmay be undefinedint | floatportmay be undefinedNumberPortmay be undefineddoublePortmay be undefined*float64#protocolmay be undefinedstringprotocolmay be undefinedstrprotocolmay be undefinedStringProtocolmay be undefinedstringProtocolmay be undefined*string#protocolVersionmay be undefinedstringprotocol_versionmay be undefinedstrprotocolVersionmay be undefinedStringProtocolVersionmay be undefinedstringProtocolVersionmay be undefined*string#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 }).
CfnElements must be defined within a stack scope (directly or indirectly).
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#targetControlPortmay be undefinednumbertarget_control_portmay be undefinedint | floattargetControlPortmay be undefinedNumberTargetControlPortmay be undefineddoubleTargetControlPortmay be undefined*float64#targetGroupAttributesmay be undefinedIResolvable | IResolvable | CfnTargetGroup.TargetGroupAttributeProperty[]target_group_attributesmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetGroupAttributeProperty]]]targetGroupAttributesmay be undefinedIResolvableTargetGroupAttributesmay be undefinedIResolvableTargetGroupAttributesmay be undefinedinterface{}#targetGroupRefTargetGroupReferencetarget_group_refTargetGroupReferencetargetGroupRefTargetGroupReferenceTargetGroupRefTargetGroupReferenceTargetGroupRefTargetGroupReference#targetsmay be undefinedIResolvable | IResolvable | CfnTargetGroup.TargetDescriptionProperty[]targetsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetDescriptionProperty]]]targetsmay be undefinedIResolvableTargetsmay be undefinedIResolvableTargetsmay be undefinedinterface{}#targetTypemay be undefinedstringtarget_typemay be undefinedstrtargetTypemay be undefinedStringTargetTypemay be undefinedstringTargetTypemay be undefined*string#unhealthyThresholdCountmay be undefinednumberunhealthy_threshold_countmay be undefinedint | floatunhealthyThresholdCountmay be undefinedNumberUnhealthyThresholdCountmay be undefineddoubleUnhealthyThresholdCountmay be undefined*float64#vpcIdmay be undefinedstringvpc_idmay be undefinedstrvpcIdmay be undefinedStringVpcIdmay be undefinedstringVpcIdmay be undefined*string#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
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:
arnForTargetGroup(resource: ITargetGroupRef): string@staticmethod def arn_for_target_group(resource: ITargetGroupRef) -> strpublic static String arnForTargetGroup(ITargetGroupRef resource)public static string ArnForTargetGroup(ITargetGroupRef resource)func ArnForTargetGroup(Resource ITargetGroupRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isCfnTargetGroup(x: any): boolean@staticmethod def is_cfn_target_group(x: Any) -> boolpublic static Boolean isCfnTargetGroup(Object x)public static bool IsCfnTargetGroup(object x)func IsCfnTargetGroup(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.