continuous_deployment_policies

Creates, updates, deletes or gets a continuous_deployment_policy resource or lists continuous_deployment_policies in a region

Overview

Name	continuous_deployment_policies
Type	Resource
Description	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.
Id	awscc.cloudfront.continuous_deployment_policies

Fields

get (all properties)

Name	Datatype	Description
▶continuous_deployment_policy_config	object	Contains the configuration for a continuous deployment policy.
id	string
last_modified_time	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::CloudFront::ContinuousDeploymentPolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	continuous_deployment_policies	INSERT	ContinuousDeploymentPolicyConfig, region
delete_resource	continuous_deployment_policies	DELETE	Identifier, region
update_resource	continuous_deployment_policies	UPDATE	Identifier, PatchDocument, region
list_resources	continuous_deployment_policies_list_only	SELECT	region
get_resource	continuous_deployment_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual continuous_deployment_policy.

SELECT
  region,
  continuous_deployment_policy_config,
  id,
  last_modified_time
FROM awscc.cloudfront.continuous_deployment_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all continuous_deployment_policies in a region.

SELECT
  region,
  id
FROM awscc.cloudfront.continuous_deployment_policies_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new continuous_deployment_policy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cloudfront.continuous_deployment_policies (
  ContinuousDeploymentPolicyConfig,
  region
)
SELECT
  '{{ continuous_deployment_policy_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudfront.continuous_deployment_policies (
  ContinuousDeploymentPolicyConfig,
  region
)
SELECT
  '{{ continuous_deployment_policy_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: continuous_deployment_policy
  props:
    - name: continuous_deployment_policy_config
      value:
        enabled: '{{ enabled }}'
        single_header_policy_config:
          header: '{{ header }}'
          value: '{{ value }}'
        single_weight_policy_config:
          session_stickiness_config:
            idle_ttl: '{{ idle_ttl }}'
            maximum_ttl: '{{ maximum_ttl }}'
          weight: null
        staging_distribution_dns_names:
          - '{{ staging_distribution_dns_names[0] }}'
        traffic_config:
          single_header_config:
            header: '{{ header }}'
            value: '{{ value }}'
          single_weight_config:
            session_stickiness_config: null
            weight: null
          type: '{{ type }}'
        type: '{{ type }}'

UPDATE example

Use the following StackQL query and manifest file to update a continuous_deployment_policy resource, using stack-deploy.

/*+ update */
UPDATE awscc.cloudfront.continuous_deployment_policies
SET PatchDocument = string('{{ {
    "ContinuousDeploymentPolicyConfig": continuous_deployment_policy_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudfront.continuous_deployment_policies
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the continuous_deployment_policies resource, the following permissions are required:

Create

cloudfront:CreateContinuousDeploymentPolicy

Delete

cloudfront:DeleteContinuousDeploymentPolicy,
cloudfront:GetContinuousDeploymentPolicy

List

cloudfront:ListContinuousDeploymentPolicies

Read

cloudfront:GetContinuousDeploymentPolicy

Update

cloudfront:UpdateContinuousDeploymentPolicy,
cloudfront:GetContinuousDeploymentPolicy