CfnDeploymentConfig
- class aws_cdk.aws_codedeploy.CfnDeploymentConfig(scope, id, *, compute_platform=None, deployment_config_name=None, minimum_healthy_hosts=None, traffic_routing_config=None)
Bases:
CfnResourceA CloudFormation
AWS::CodeDeploy::DeploymentConfig.The
AWS::CodeDeploy::DeploymentConfigresource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of aMinimumHealthyHostsvalue, the number or percentage of instances that must remain available at any time during a deployment.- CloudformationResource:
AWS::CodeDeploy::DeploymentConfig
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codedeploy as codedeploy cfn_deployment_config = codedeploy.CfnDeploymentConfig(self, "MyCfnDeploymentConfig", compute_platform="computePlatform", deployment_config_name="deploymentConfigName", minimum_healthy_hosts=codedeploy.CfnDeploymentConfig.MinimumHealthyHostsProperty( type="type", value=123 ), traffic_routing_config=codedeploy.CfnDeploymentConfig.TrafficRoutingConfigProperty( type="type", # the properties below are optional time_based_canary=codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty( canary_interval=123, canary_percentage=123 ), time_based_linear=codedeploy.CfnDeploymentConfig.TimeBasedLinearProperty( linear_interval=123, linear_percentage=123 ) ) )
Create a new
AWS::CodeDeploy::DeploymentConfig.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
compute_platform (
Optional[str]) – The destination platform type for the deployment (Lambda,Server, orECS).deployment_config_name (
Optional[str]) – A name for the deployment configuration. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type . .. epigraph:: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.minimum_healthy_hosts (
Union[MinimumHealthyHostsProperty,Dict[str,Any],IResolvable,None]) – The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. The type parameter takes either of the following values: - HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value. - FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances. The value parameter takes an integer. For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95. For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.traffic_routing_config (
Union[IResolvable,TrafficRoutingConfigProperty,Dict[str,Any],None]) – The configuration that specifies how the deployment traffic is routed.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill 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:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CodeDeploy::DeploymentConfig'
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- compute_platform
The destination platform type for the deployment (
Lambda,Server, orECS).
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- deployment_config_name
A name for the deployment configuration.
If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type . .. epigraph:
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- logical_id
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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- minimum_healthy_hosts
The minimum number of healthy instances that should be available at any time during the deployment.
There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.
- node
The construct tree node associated with this construct.
- ref
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
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- traffic_routing_config
The configuration that specifies how the deployment traffic is routed.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
MinimumHealthyHostsProperty
- class CfnDeploymentConfig.MinimumHealthyHostsProperty(*, type, value)
Bases:
objectMinimumHealthyHostsis a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.- Parameters:
type (
str) – The minimum healthy instance type:. - HOST_COUNT: The minimum number of healthy instance as an absolute value. - FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment. In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails. .. epigraph:: In a call toGetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful. For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide .value (
Union[int,float]) – The minimum healthy instance value.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codedeploy as codedeploy minimum_healthy_hosts_property = codedeploy.CfnDeploymentConfig.MinimumHealthyHostsProperty( type="type", value=123 )
Attributes
- type
.
HOST_COUNT: The minimum number of healthy instance as an absolute value.
FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.
In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails. .. epigraph:
In a call to ``GetDeploymentConfig`` , CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.
For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide .
- value
The minimum healthy instance value.
TimeBasedCanaryProperty
- class CfnDeploymentConfig.TimeBasedCanaryProperty(*, canary_interval, canary_percentage)
Bases:
objectA configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.
The original and target Lambda function versions or ECS task sets are specified in the deployment’s AppSpec file.
- Parameters:
canary_interval (
Union[int,float]) – The number of minutes between the first and second traffic shifts of aTimeBasedCanarydeployment.canary_percentage (
Union[int,float]) – The percentage of traffic to shift in the first increment of aTimeBasedCanarydeployment.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codedeploy as codedeploy time_based_canary_property = codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty( canary_interval=123, canary_percentage=123 )
Attributes
- canary_interval
The number of minutes between the first and second traffic shifts of a
TimeBasedCanarydeployment.
- canary_percentage
The percentage of traffic to shift in the first increment of a
TimeBasedCanarydeployment.
TimeBasedLinearProperty
- class CfnDeploymentConfig.TimeBasedLinearProperty(*, linear_interval, linear_percentage)
Bases:
objectA configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment.
The original and target Lambda function versions or ECS task sets are specified in the deployment’s AppSpec file.
- Parameters:
linear_interval (
Union[int,float]) – The number of minutes between each incremental traffic shift of aTimeBasedLineardeployment.linear_percentage (
Union[int,float]) – The percentage of traffic that is shifted at the start of each increment of aTimeBasedLineardeployment.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codedeploy as codedeploy time_based_linear_property = codedeploy.CfnDeploymentConfig.TimeBasedLinearProperty( linear_interval=123, linear_percentage=123 )
Attributes
- linear_interval
The number of minutes between each incremental traffic shift of a
TimeBasedLineardeployment.
- linear_percentage
The percentage of traffic that is shifted at the start of each increment of a
TimeBasedLineardeployment.
TrafficRoutingConfigProperty
- class CfnDeploymentConfig.TrafficRoutingConfigProperty(*, type, time_based_canary=None, time_based_linear=None)
Bases:
objectThe configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.
- Parameters:
type (
str) – The type of traffic shifting (TimeBasedCanaryorTimeBasedLinear) used by a deployment configuration.time_based_canary (
Union[IResolvable,TimeBasedCanaryProperty,Dict[str,Any],None]) – A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment’s AppSpec file.time_based_linear (
Union[IResolvable,TimeBasedLinearProperty,Dict[str,Any],None]) – A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment’s AppSpec file.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codedeploy as codedeploy traffic_routing_config_property = codedeploy.CfnDeploymentConfig.TrafficRoutingConfigProperty( type="type", # the properties below are optional time_based_canary=codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty( canary_interval=123, canary_percentage=123 ), time_based_linear=codedeploy.CfnDeploymentConfig.TimeBasedLinearProperty( linear_interval=123, linear_percentage=123 ) )
Attributes
- time_based_canary
A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments.
The original and target Lambda function versions or ECS task sets are specified in the deployment’s AppSpec file.
- time_based_linear
A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment.
The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment’s AppSpec file.
- type
The type of traffic shifting (
TimeBasedCanaryorTimeBasedLinear) used by a deployment configuration.