CfnFleet L1 construct
The AWS::CodeBuild::Fleet resource configures a compute fleet, a set of dedicated instances for your build environment.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnFleet = new codebuild.CfnFleet(this, 'MyCfnFleet', /* all optional props */ {
baseCapacity: 123,
computeConfiguration: {
disk: 123,
instanceType: 'instanceType',
machineType: 'machineType',
memory: 123,
vCpu: 123,
},
computeType: 'computeType',
environmentType: 'environmentType',
fleetProxyConfiguration: {
defaultBehavior: 'defaultBehavior',
orderedProxyRules: [{
effect: 'effect',
entities: ['entities'],
type: 'type',
}],
},
fleetServiceRole: 'fleetServiceRole',
fleetVpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
vpcId: 'vpcId',
},
imageId: 'imageId',
name: 'name',
overflowBehavior: 'overflowBehavior',
scalingConfiguration: {
maxCapacity: 123,
scalingType: 'scalingType',
targetTrackingScalingConfigs: [{
metricType: 'metricType',
targetValue: 123,
}],
},
tags: [{
key: 'key',
value: 'value',
}],
});
python
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_codebuild as codebuild
cfn_fleet = codebuild.CfnFleet(self, "MyCfnFleet",
base_capacity=123,
compute_configuration=codebuild.CfnFleet.ComputeConfigurationProperty(
disk=123,
instance_type="instanceType",
machine_type="machineType",
memory=123,
v_cpu=123
),
compute_type="computeType",
environment_type="environmentType",
fleet_proxy_configuration=codebuild.CfnFleet.ProxyConfigurationProperty(
default_behavior="defaultBehavior",
ordered_proxy_rules=[codebuild.CfnFleet.FleetProxyRuleProperty(
effect="effect",
entities=["entities"],
type="type"
)]
),
fleet_service_role="fleetServiceRole",
fleet_vpc_config=codebuild.CfnFleet.VpcConfigProperty(
security_group_ids=["securityGroupIds"],
subnets=["subnets"],
vpc_id="vpcId"
),
image_id="imageId",
name="name",
overflow_behavior="overflowBehavior",
scaling_configuration=codebuild.CfnFleet.ScalingConfigurationInputProperty(
max_capacity=123,
scaling_type="scalingType",
target_tracking_scaling_configs=[codebuild.CfnFleet.TargetTrackingScalingConfigurationProperty(
metric_type="metricType",
target_value=123
)]
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;
CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet")
.baseCapacity(123)
.computeConfiguration(ComputeConfigurationProperty.builder()
.disk(123)
.instanceType("instanceType")
.machineType("machineType")
.memory(123)
.vCpu(123)
.build())
.computeType("computeType")
.environmentType("environmentType")
.fleetProxyConfiguration(ProxyConfigurationProperty.builder()
.defaultBehavior("defaultBehavior")
.orderedProxyRules(List.of(FleetProxyRuleProperty.builder()
.effect("effect")
.entities(List.of("entities"))
.type("type")
.build()))
.build())
.fleetServiceRole("fleetServiceRole")
.fleetVpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnets(List.of("subnets"))
.vpcId("vpcId")
.build())
.imageId("imageId")
.name("name")
.overflowBehavior("overflowBehavior")
.scalingConfiguration(ScalingConfigurationInputProperty.builder()
.maxCapacity(123)
.scalingType("scalingType")
.targetTrackingScalingConfigs(List.of(TargetTrackingScalingConfigurationProperty.builder()
.metricType("metricType")
.targetValue(123)
.build()))
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// 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.CodeBuild;
var cfnFleet = new CfnFleet(this, "MyCfnFleet", new CfnFleetProps {
BaseCapacity = 123,
ComputeConfiguration = new ComputeConfigurationProperty {
Disk = 123,
InstanceType = "instanceType",
MachineType = "machineType",
Memory = 123,
VCpu = 123
},
ComputeType = "computeType",
EnvironmentType = "environmentType",
FleetProxyConfiguration = new ProxyConfigurationProperty {
DefaultBehavior = "defaultBehavior",
OrderedProxyRules = new [] { new FleetProxyRuleProperty {
Effect = "effect",
Entities = new [] { "entities" },
Type = "type"
} }
},
FleetServiceRole = "fleetServiceRole",
FleetVpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" },
VpcId = "vpcId"
},
ImageId = "imageId",
Name = "name",
OverflowBehavior = "overflowBehavior",
ScalingConfiguration = new ScalingConfigurationInputProperty {
MaxCapacity = 123,
ScalingType = "scalingType",
TargetTrackingScalingConfigs = new [] { new TargetTrackingScalingConfigurationProperty {
MetricType = "metricType",
TargetValue = 123
} }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
go
// 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"
cfnFleet := awscdk.Aws_codebuild.NewCfnFleet(this, jsii.String("MyCfnFleet"), &CfnFleetProps{
BaseCapacity: jsii.Number(123),
ComputeConfiguration: &ComputeConfigurationProperty{
Disk: jsii.Number(123),
InstanceType: jsii.String("instanceType"),
MachineType: jsii.String("machineType"),
Memory: jsii.Number(123),
VCpu: jsii.Number(123),
},
ComputeType: jsii.String("computeType"),
EnvironmentType: jsii.String("environmentType"),
FleetProxyConfiguration: &ProxyConfigurationProperty{
DefaultBehavior: jsii.String("defaultBehavior"),
OrderedProxyRules: []interface{}{
&FleetProxyRuleProperty{
Effect: jsii.String("effect"),
Entities: []*string{
jsii.String("entities"),
},
Type: jsii.String("type"),
},
},
},
FleetServiceRole: jsii.String("fleetServiceRole"),
FleetVpcConfig: &VpcConfigProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
Subnets: []*string{
jsii.String("subnets"),
},
VpcId: jsii.String("vpcId"),
},
ImageId: jsii.String("imageId"),
Name: jsii.String("name"),
OverflowBehavior: jsii.String("overflowBehavior"),
ScalingConfiguration: &ScalingConfigurationInputProperty{
MaxCapacity: jsii.Number(123),
ScalingType: jsii.String("scalingType"),
TargetTrackingScalingConfigs: []interface{}{
&TargetTrackingScalingConfigurationProperty{
MetricType: jsii.String("metricType"),
TargetValue: jsii.Number(123),
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
ts
new CfnFleet(scope: Construct, id: string, props?: CfnFleetProps)
python
CfnFleet(scope: Construct, id: str, props: typing.Optional[CfnFleetProps] = None)
java
new CfnFleet(Construct scope, String id, CfnFleetProps props)
csharp
new CfnFleet(Construct scope, string id, CfnFleetProps? props = null)
go
NewCfnFleet(Scope Construct, Id *string, Props CfnFleetProps)
Construct Props
The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
computeConfigurationIResolvable | CfnFleet.ComputeConfigurationPropertycompute_configurationtyping.Union[IResolvable, ComputeConfigurationProperty]computeConfigurationIResolvableComputeConfigurationIResolvableComputeConfigurationinterface{}#The compute configuration of the compute fleet.
This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE .
Information about the compute resources the compute fleet uses. Available values include:.
notes
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL :
- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE :
- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
environmentTypestringenvironment_typestrenvironmentTypeStringEnvironmentTypestringEnvironmentType*string#The environment type of the compute fleet.
notes
- The environment type
ARM_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo). - The environment type
ARM_EC2is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). - The environment type
LINUX_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). - The environment type
LINUX_EC2is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). - The environment type
LINUX_GPU_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). - The environment type
MAC_ARMis available only in regions US East (Ohio), US East (N. Virginia), US West (Oregon), Europe (Frankfurt), and Asia Pacific (Sydney). - The environment type
WINDOWS_EC2is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). - The environment type
WINDOWS_SERVER_2019_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). - The environment type
WINDOWS_SERVER_2022_CONTAINERis available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the AWS CodeBuild user guide .
fleetProxyConfigurationIResolvable | CfnFleet.ProxyConfigurationPropertyfleet_proxy_configurationtyping.Union[IResolvable, ProxyConfigurationProperty]fleetProxyConfigurationIResolvableFleetProxyConfigurationIResolvableFleetProxyConfigurationinterface{}#Information about the proxy configurations that apply network access control to your reserved capacity instances.
fleetServiceRolestringfleet_service_rolestrfleetServiceRoleStringFleetServiceRolestringFleetServiceRole*string#The service role associated with the compute fleet.
notes
For more information, see Allow a user to add a permission policy for a fleet service role in the AWS CodeBuild User Guide .
fleetVpcConfigIResolvable | CfnFleet.VpcConfigPropertyfleet_vpc_configtyping.Union[IResolvable, VpcConfigProperty]fleetVpcConfigIResolvableFleetVpcConfigIResolvableFleetVpcConfiginterface{}#Information about the VPC configuration that AWS CodeBuild accesses.
The Amazon Machine Image (AMI) of the compute fleet.
The name of the compute fleet.
overflowBehaviorstringoverflow_behaviorstroverflowBehaviorStringOverflowBehaviorstringOverflowBehavior*string#The compute fleet overflow behavior.
notes
- For overflow behavior
QUEUE, your overflow builds need to wait on the existing fleet instance to become available. - For overflow behavior
ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to AWS services required to create a VPC network interface .
scalingConfigurationIResolvable | CfnFleet.ScalingConfigurationInputPropertyscaling_configurationtyping.Union[IResolvable, ScalingConfigurationInputProperty]scalingConfigurationIResolvableScalingConfigurationIResolvableScalingConfigurationinterface{}#The scaling configuration of the compute fleet.
Properties
The ARN of the compute fleet.
The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
computeConfigurationIResolvable | CfnFleet.ComputeConfigurationPropertycompute_configurationtyping.Union[IResolvable, ComputeConfigurationProperty]computeConfigurationIResolvableComputeConfigurationIResolvableComputeConfigurationinterface{}#The compute configuration of the compute fleet.
Information about the compute resources the compute fleet uses.
Available values include:.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#environmentTypestringenvironment_typestrenvironmentTypeStringEnvironmentTypestringEnvironmentType*string#The environment type of the compute fleet.
fleetProxyConfigurationIResolvable | CfnFleet.ProxyConfigurationPropertyfleet_proxy_configurationtyping.Union[IResolvable, ProxyConfigurationProperty]fleetProxyConfigurationIResolvableFleetProxyConfigurationIResolvableFleetProxyConfigurationinterface{}#Information about the proxy configurations that apply network access control to your reserved capacity instances.
fleetRefFleetReferencefleet_refFleetReferencefleetRefFleetReferenceFleetRefFleetReferenceFleetRefFleetReferencerequired#A reference to a Fleet resource.
fleetServiceRolestringfleet_service_rolestrfleetServiceRoleStringFleetServiceRolestringFleetServiceRole*string#The service role associated with the compute fleet.
fleetVpcConfigIResolvable | CfnFleet.VpcConfigPropertyfleet_vpc_configtyping.Union[IResolvable, VpcConfigProperty]fleetVpcConfigIResolvableFleetVpcConfigIResolvableFleetVpcConfiginterface{}#Information about the VPC configuration that AWS CodeBuild accesses.
The Amazon Machine Image (AMI) of the compute fleet.
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).
The name of the compute fleet.
overflowBehaviorstringoverflow_behaviorstroverflowBehaviorStringOverflowBehaviorstringOverflowBehavior*string#The compute fleet overflow behavior.
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 }).
scalingConfigurationIResolvable | CfnFleet.ScalingConfigurationInputPropertyscaling_configurationtyping.Union[IResolvable, ScalingConfigurationInputProperty]scalingConfigurationIResolvableScalingConfigurationIResolvableScalingConfigurationinterface{}#The scaling configuration of the compute fleet.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
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)#Syntactic sugar for `addOverride(path, undefined)`.
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#Use `addResourceDependency` instead.
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#Use `addResourceDependency` instead.
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{})#Add a value to the CloudFormation Resource Metadata.
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{})#Adds an override to the synthesized CloudFormation resource.
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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)#Adds an override that deletes the value of a property from the resource definition.
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{})#Adds an override to a resource property.
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)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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)#Sets the cross-stack reference strength for this resource.
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)#Sets the deletion policy of the resource based on the removal policy specified.
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:
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#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.
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{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
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#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
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.
isCfnFleet(x: any): boolean@staticmethod def is_cfn_fleet(x: Any) -> boolpublic static Boolean isCfnFleet(Object x)public static bool IsCfnFleet(object x)func IsCfnFleet(X interface{}) *boolstatic#Checks whether the given object is a CfnFleet.
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#Check whether the given object is a CfnResource.
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#Checks if `x` is a construct.
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{}#Retrieves an array of resources and stacks this resource depends on.
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)#Overrides the auto-generated logical ID with a specific ID.
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#Use `removeResourceDependency` instead
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)#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: 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)#Replaces one dependency with another.
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 a string representation of this construct.
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#Applies one or more mixins to this construct.
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.