class DeploymentStrategy (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.DeploymentStrategy |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#DeploymentStrategy |
Java | software.amazon.awscdk.services.appconfig.alpha.DeploymentStrategy |
Python | aws_cdk.aws_appconfig_alpha.DeploymentStrategy |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » DeploymentStrategy |
⚠️ Deprecated: undefined
Implements
IConstruct
, IDependable
, IResource
, IDeployment
An AWS AppConfig deployment strategy.
See also: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
declare const rolloutStrategy: appconfig_alpha.RolloutStrategy;
const deploymentStrategy = new appconfig_alpha.DeploymentStrategy(this, 'MyDeploymentStrategy', {
rolloutStrategy: rolloutStrategy,
// the properties below are optional
deploymentStrategyName: 'deploymentStrategyName',
description: 'description',
});
Initializer
new DeploymentStrategy(scope: Construct, id: string, props: DeploymentStrategyProps)
⚠️ Deprecated: undefined
Parameters
- scope
Construct
- id
string
- props
Deployment
Strategy Props
Construct Props
Name | Type | Description |
---|---|---|
rollout | Rollout | The rollout strategy for the deployment strategy. |
deployment | string | A name for the deployment strategy. |
description? | string | A description of the deployment strategy. |
rolloutStrategy
⚠️ Deprecated: undefined
Type:
Rollout
The rollout strategy for the deployment strategy.
You can use predefined deployment strategies, such as RolloutStrategy.ALL_AT_ONCE, RolloutStrategy.LINEAR_50_PERCENT_EVERY_30_SECONDS, or RolloutStrategy.CANARY_10_PERCENT_20_MINUTES.
deploymentStrategyName?
⚠️ Deprecated: undefined
Type:
string
(optional, default: A name is generated.)
A name for the deployment strategy.
description?
⚠️ Deprecated: undefined
Type:
string
(optional, default: No description.)
A description of the deployment strategy.
Properties
Name | Type | Description |
---|---|---|
deployment | string | The Amazon Resource Name (ARN) of the deployment strategy. |
deployment | string | The ID of the deployment strategy. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
deployment | number | The deployment duration in minutes of the deployment strategy. |
description? | string | The description of the deployment strategy. |
final | number | The final bake time in minutes of the deployment strategy. |
growth | number | The growth factor of the deployment strategy. |
growth | Growth | The growth type of the deployment strategy. |
name? | string | The name of the deployment strategy. |
deploymentStrategyArn
⚠️ Deprecated: undefined
Type:
string
The Amazon Resource Name (ARN) of the deployment strategy.
deploymentStrategyId
⚠️ Deprecated: undefined
Type:
string
The ID of the deployment strategy.
env
⚠️ Deprecated: undefined
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
⚠️ Deprecated: undefined
Type:
Node
The tree node.
stack
⚠️ Deprecated: undefined
Type:
Stack
The stack in which this resource is defined.
deploymentDurationInMinutes?
⚠️ Deprecated: undefined
Type:
number
(optional)
The deployment duration in minutes of the deployment strategy.
description?
⚠️ Deprecated: undefined
Type:
string
(optional)
The description of the deployment strategy.
finalBakeTimeInMinutes?
⚠️ Deprecated: undefined
Type:
number
(optional)
The final bake time in minutes of the deployment strategy.
growthFactor?
⚠️ Deprecated: undefined
Type:
number
(optional)
The growth factor of the deployment strategy.
growthType?
⚠️ Deprecated: undefined
Type:
Growth
(optional)
The growth type of the deployment strategy.
name?
⚠️ Deprecated: undefined
Type:
string
(optional)
The name of the deployment strategy.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports a deployment strategy into the CDK using its Amazon Resource Name (ARN). |
static from | Imports a deployment strategy into the CDK using its ID. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
⚠️ Deprecated: undefined
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
String()
topublic toString(): string
⚠️ Deprecated: undefined
Returns
string
Returns a string representation of this construct.
DeploymentStrategyArn(scope, id, deploymentStrategyArn)
static frompublic static fromDeploymentStrategyArn(scope: Construct, id: string, deploymentStrategyArn: string): IDeploymentStrategy
⚠️ Deprecated: undefined
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the deployment strategy construct. - deploymentStrategyArn
string
— The Amazon Resource Name (ARN) of the deployment strategy.
Returns
Imports a deployment strategy into the CDK using its Amazon Resource Name (ARN).
DeploymentStrategyId(scope, id, deploymentStrategyId)
static frompublic static fromDeploymentStrategyId(scope: Construct, id: string, deploymentStrategyId: DeploymentStrategyId): IDeploymentStrategy
⚠️ Deprecated: undefined
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the deployment strategy construct. - deploymentStrategyId
Deployment
— The ID of the deployment strategy.Strategy Id
Returns
Imports a deployment strategy into the CDK using its ID.