software.amazon.awscdk.services.cloudfront

Class CfnContinuousDeploymentPolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudfront.CfnContinuousDeploymentPolicy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.098Z")
public class CfnContinuousDeploymentPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFront::ContinuousDeploymentPolicy`.

Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.

After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.

For more information, see Using CloudFront continuous deployment to safely test CDN configuration changes in the Amazon CloudFront Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnContinuousDeploymentPolicy cfnContinuousDeploymentPolicy = CfnContinuousDeploymentPolicy.Builder.create(this, "MyCfnContinuousDeploymentPolicy")
         .continuousDeploymentPolicyConfig(ContinuousDeploymentPolicyConfigProperty.builder()
                 .enabled(false)
                 .stagingDistributionDnsNames(List.of("stagingDistributionDnsNames"))
                 // the properties below are optional
                 .trafficConfig(TrafficConfigProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .singleHeaderConfig(SingleHeaderConfigProperty.builder()
                                 .header("header")
                                 .value("value")
                                 .build())
                         .singleWeightConfig(SingleWeightConfigProperty.builder()
                                 .weight(123)
                                 // the properties below are optional
                                 .sessionStickinessConfig(SessionStickinessConfigProperty.builder()
                                         .idleTtl(123)
                                         .maximumTtl(123)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContinuousDeploymentPolicy.Builder A fluent builder for CfnContinuousDeploymentPolicy.
static interface	CfnContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfigProperty Contains the configuration for a continuous deployment policy.
static interface	CfnContinuousDeploymentPolicy.SessionStickinessConfigProperty Session stickiness provides the ability to define multiple requests from a single viewer as a single session.
static interface	CfnContinuousDeploymentPolicy.SingleHeaderConfigProperty Determines which HTTP requests are sent to the staging distribution.
static interface	CfnContinuousDeploymentPolicy.SingleWeightConfigProperty This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
static interface	CfnContinuousDeploymentPolicy.TrafficConfigProperty The traffic configuration of your continuous deployment.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnContinuousDeploymentPolicy(Construct scope, java.lang.String id, CfnContinuousDeploymentPolicyProps props) Create a new `AWS::CloudFront::ContinuousDeploymentPolicy`.
protected	CfnContinuousDeploymentPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContinuousDeploymentPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrId() The identifier of the cotinuous deployment policy.
java.lang.String	getAttrLastModifiedTime() The date and time when the continuous deployment policy was last modified.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getContinuousDeploymentPolicyConfig() Contains the configuration for a continuous deployment policy.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setContinuousDeploymentPolicyConfig(CfnContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfigProperty value) Contains the configuration for a continuous deployment policy.
void	setContinuousDeploymentPolicyConfig(IResolvable value) Contains the configuration for a continuous deployment policy.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnContinuousDeploymentPolicy

protected CfnContinuousDeploymentPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnContinuousDeploymentPolicy

protected CfnContinuousDeploymentPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnContinuousDeploymentPolicy

public CfnContinuousDeploymentPolicy(Construct scope,
                                     java.lang.String id,
                                     CfnContinuousDeploymentPolicyProps props)

Create a new `AWS::CloudFront::ContinuousDeploymentPolicy`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The identifier of the cotinuous deployment policy.

getAttrLastModifiedTime

public java.lang.String getAttrLastModifiedTime()

The date and time when the continuous deployment policy was last modified.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getContinuousDeploymentPolicyConfig

public java.lang.Object getContinuousDeploymentPolicyConfig()

Contains the configuration for a continuous deployment policy.

setContinuousDeploymentPolicyConfig

public void setContinuousDeploymentPolicyConfig(IResolvable value)

Contains the configuration for a continuous deployment policy.

setContinuousDeploymentPolicyConfig

public void setContinuousDeploymentPolicyConfig(CfnContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfigProperty value)

Contains the configuration for a continuous deployment policy.