1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudfront
  5. ContinuousDeploymentPolicy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.cloudfront.ContinuousDeploymentPolicy

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    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.

    Create ContinuousDeploymentPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ContinuousDeploymentPolicy(name: string, args: ContinuousDeploymentPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def ContinuousDeploymentPolicy(resource_name: str,
                                   args: ContinuousDeploymentPolicyArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ContinuousDeploymentPolicy(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   continuous_deployment_policy_config: Optional[ContinuousDeploymentPolicyConfigArgs] = None)
    func NewContinuousDeploymentPolicy(ctx *Context, name string, args ContinuousDeploymentPolicyArgs, opts ...ResourceOption) (*ContinuousDeploymentPolicy, error)
    public ContinuousDeploymentPolicy(string name, ContinuousDeploymentPolicyArgs args, CustomResourceOptions? opts = null)
    public ContinuousDeploymentPolicy(String name, ContinuousDeploymentPolicyArgs args)
    public ContinuousDeploymentPolicy(String name, ContinuousDeploymentPolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudfront:ContinuousDeploymentPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ContinuousDeploymentPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ContinuousDeploymentPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ContinuousDeploymentPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContinuousDeploymentPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContinuousDeploymentPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ContinuousDeploymentPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ContinuousDeploymentPolicy resource accepts the following input properties:

    ContinuousDeploymentPolicyConfig ContinuousDeploymentPolicyConfigArgs
    Contains the configuration for a continuous deployment policy.
    continuousDeploymentPolicyConfig ContinuousDeploymentPolicyConfig
    Contains the configuration for a continuous deployment policy.
    continuousDeploymentPolicyConfig ContinuousDeploymentPolicyConfig
    Contains the configuration for a continuous deployment policy.
    continuous_deployment_policy_config ContinuousDeploymentPolicyConfigArgs
    Contains the configuration for a continuous deployment policy.
    continuousDeploymentPolicyConfig Property Map
    Contains the configuration for a continuous deployment policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ContinuousDeploymentPolicy resource produces the following output properties:

    AwsId string
    The identifier of the cotinuous deployment policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time when the continuous deployment policy was last modified.
    AwsId string
    The identifier of the cotinuous deployment policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time when the continuous deployment policy was last modified.
    awsId String
    The identifier of the cotinuous deployment policy.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time when the continuous deployment policy was last modified.
    awsId string
    The identifier of the cotinuous deployment policy.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The date and time when the continuous deployment policy was last modified.
    aws_id str
    The identifier of the cotinuous deployment policy.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    The date and time when the continuous deployment policy was last modified.
    awsId String
    The identifier of the cotinuous deployment policy.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time when the continuous deployment policy was last modified.

    Supporting Types

    ContinuousDeploymentPolicyConfig, ContinuousDeploymentPolicyConfigArgs

    Enabled bool
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    StagingDistributionDnsNames List<string>
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    SingleHeaderPolicyConfig Pulumi.AwsNative.CloudFront.Inputs.ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    SingleWeightPolicyConfig Pulumi.AwsNative.CloudFront.Inputs.ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    TrafficConfig Pulumi.AwsNative.CloudFront.Inputs.ContinuousDeploymentPolicyTrafficConfig
    Contains the parameters for routing production traffic from your primary to staging distributions.
    Type Pulumi.AwsNative.CloudFront.ContinuousDeploymentPolicyConfigType
    The type of traffic configuration.
    Enabled bool
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    StagingDistributionDnsNames []string
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    SingleHeaderPolicyConfig ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    SingleWeightPolicyConfig ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    TrafficConfig ContinuousDeploymentPolicyTrafficConfig
    Contains the parameters for routing production traffic from your primary to staging distributions.
    Type ContinuousDeploymentPolicyConfigType
    The type of traffic configuration.
    enabled Boolean
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    stagingDistributionDnsNames List<String>
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    singleHeaderPolicyConfig ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    singleWeightPolicyConfig ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    trafficConfig ContinuousDeploymentPolicyTrafficConfig
    Contains the parameters for routing production traffic from your primary to staging distributions.
    type ContinuousDeploymentPolicyConfigType
    The type of traffic configuration.
    enabled boolean
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    stagingDistributionDnsNames string[]
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    singleHeaderPolicyConfig ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    singleWeightPolicyConfig ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    trafficConfig ContinuousDeploymentPolicyTrafficConfig
    Contains the parameters for routing production traffic from your primary to staging distributions.
    type ContinuousDeploymentPolicyConfigType
    The type of traffic configuration.
    enabled bool
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    staging_distribution_dns_names Sequence[str]
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    single_header_policy_config ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    single_weight_policy_config ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    traffic_config ContinuousDeploymentPolicyTrafficConfig
    Contains the parameters for routing production traffic from your primary to staging distributions.
    type ContinuousDeploymentPolicyConfigType
    The type of traffic configuration.
    enabled Boolean
    A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
    stagingDistributionDnsNames List<String>
    The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
    singleHeaderPolicyConfig Property Map
    This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
    singleWeightPolicyConfig Property Map
    This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
    trafficConfig Property Map
    Contains the parameters for routing production traffic from your primary to staging distributions.
    type "SingleWeight" | "SingleHeader"
    The type of traffic configuration.

    ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties, ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigPropertiesArgs

    Header string
    Value string
    Header string
    Value string
    header String
    value String
    header string
    value string
    header str
    value str
    header String
    value String

    ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties, ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigPropertiesArgs

    ContinuousDeploymentPolicyConfigType, ContinuousDeploymentPolicyConfigTypeArgs

    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    ContinuousDeploymentPolicyConfigTypeSingleWeight
    SingleWeight
    ContinuousDeploymentPolicyConfigTypeSingleHeader
    SingleHeader
    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    SINGLE_WEIGHT
    SingleWeight
    SINGLE_HEADER
    SingleHeader
    "SingleWeight"
    SingleWeight
    "SingleHeader"
    SingleHeader

    ContinuousDeploymentPolicySessionStickinessConfig, ContinuousDeploymentPolicySessionStickinessConfigArgs

    IdleTtl int
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    MaximumTtl int
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
    IdleTtl int
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    MaximumTtl int
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
    idleTtl Integer
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    maximumTtl Integer
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
    idleTtl number
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    maximumTtl number
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
    idle_ttl int
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    maximum_ttl int
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
    idleTtl Number
    The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
    maximumTtl Number
    The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).

    ContinuousDeploymentPolicySingleHeaderConfig, ContinuousDeploymentPolicySingleHeaderConfigArgs

    Header string
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    Value string
    The request header value.
    Header string
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    Value string
    The request header value.
    header String
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    value String
    The request header value.
    header string
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    value string
    The request header value.
    header str
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    value str
    The request header value.
    header String
    The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
    value String
    The request header value.

    ContinuousDeploymentPolicySingleWeightConfig, ContinuousDeploymentPolicySingleWeightConfigArgs

    Weight double
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    SessionStickinessConfig Pulumi.AwsNative.CloudFront.Inputs.ContinuousDeploymentPolicySessionStickinessConfig
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
    Weight float64
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    SessionStickinessConfig ContinuousDeploymentPolicySessionStickinessConfig
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
    weight Double
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    sessionStickinessConfig ContinuousDeploymentPolicySessionStickinessConfig
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
    weight number
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    sessionStickinessConfig ContinuousDeploymentPolicySessionStickinessConfig
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
    weight float
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    session_stickiness_config ContinuousDeploymentPolicySessionStickinessConfig
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
    weight Number
    The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
    sessionStickinessConfig Property Map
    Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.

    ContinuousDeploymentPolicyTrafficConfig, ContinuousDeploymentPolicyTrafficConfigArgs

    Type ContinuousDeploymentPolicyTrafficConfigType
    The type of traffic configuration.
    SingleHeaderConfig ContinuousDeploymentPolicySingleHeaderConfig
    Determines which HTTP requests are sent to the staging distribution.
    SingleWeightConfig ContinuousDeploymentPolicySingleWeightConfig
    Contains the percentage of traffic to send to the staging distribution.
    type ContinuousDeploymentPolicyTrafficConfigType
    The type of traffic configuration.
    singleHeaderConfig ContinuousDeploymentPolicySingleHeaderConfig
    Determines which HTTP requests are sent to the staging distribution.
    singleWeightConfig ContinuousDeploymentPolicySingleWeightConfig
    Contains the percentage of traffic to send to the staging distribution.
    type ContinuousDeploymentPolicyTrafficConfigType
    The type of traffic configuration.
    singleHeaderConfig ContinuousDeploymentPolicySingleHeaderConfig
    Determines which HTTP requests are sent to the staging distribution.
    singleWeightConfig ContinuousDeploymentPolicySingleWeightConfig
    Contains the percentage of traffic to send to the staging distribution.
    type ContinuousDeploymentPolicyTrafficConfigType
    The type of traffic configuration.
    single_header_config ContinuousDeploymentPolicySingleHeaderConfig
    Determines which HTTP requests are sent to the staging distribution.
    single_weight_config ContinuousDeploymentPolicySingleWeightConfig
    Contains the percentage of traffic to send to the staging distribution.
    type "SingleWeight" | "SingleHeader"
    The type of traffic configuration.
    singleHeaderConfig Property Map
    Determines which HTTP requests are sent to the staging distribution.
    singleWeightConfig Property Map
    Contains the percentage of traffic to send to the staging distribution.

    ContinuousDeploymentPolicyTrafficConfigType, ContinuousDeploymentPolicyTrafficConfigTypeArgs

    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    ContinuousDeploymentPolicyTrafficConfigTypeSingleWeight
    SingleWeight
    ContinuousDeploymentPolicyTrafficConfigTypeSingleHeader
    SingleHeader
    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    SingleWeight
    SingleWeight
    SingleHeader
    SingleHeader
    SINGLE_WEIGHT
    SingleWeight
    SINGLE_HEADER
    SingleHeader
    "SingleWeight"
    SingleWeight
    "SingleHeader"
    SingleHeader

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi