Package software.amazon.awscdk.services.cloudfront

Class CfnContinuousDeploymentPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.468Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnContinuousDeploymentPolicy

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

    • CfnContinuousDeploymentPolicy

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

    • CfnContinuousDeploymentPolicy

      @Stability(Stable) public CfnContinuousDeploymentPolicy(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the cotinuous deployment policy.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The date and time when the continuous deployment policy was last modified.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getContinuousDeploymentPolicyConfig

      @Stability(Stable) @NotNull public Object getContinuousDeploymentPolicyConfig()
      Contains the configuration for a continuous deployment policy.

    • setContinuousDeploymentPolicyConfig

      @Stability(Stable) public void setContinuousDeploymentPolicyConfig(@NotNull IResolvable value)
      Contains the configuration for a continuous deployment policy.

    • setContinuousDeploymentPolicyConfig

      @Stability(Stable) public void setContinuousDeploymentPolicyConfig(@NotNull CfnContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfigProperty value)
      Contains the configuration for a continuous deployment policy.