Skip to content

Update Continuous Deployment Policy

cloudfront_update_continuous_deployment_policy R Documentation

Updates a continuous deployment policy

Description

Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.

When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:

  1. Use get_continuous_deployment_policy_config to get the current configuration.

  2. Locally modify the fields in the continuous deployment policy configuration that you want to update.

  3. Use update_continuous_deployment_policy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.

Usage

cloudfront_update_continuous_deployment_policy(
  ContinuousDeploymentPolicyConfig, Id, IfMatch)

Arguments

ContinuousDeploymentPolicyConfig

[required] The continuous deployment policy configuration.

Id

[required] The identifier of the continuous deployment policy that you are updating.

IfMatch

The current version (ETag value) of the continuous deployment policy that you are updating.

Value

A list with the following syntax:

list(
  ContinuousDeploymentPolicy = list(
    Id = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    ContinuousDeploymentPolicyConfig = list(
      StagingDistributionDnsNames = list(
        Quantity = 123,
        Items = list(
          "string"
        )
      ),
      Enabled = TRUE|FALSE,
      TrafficConfig = list(
        SingleWeightConfig = list(
          Weight = 123.0,
          SessionStickinessConfig = list(
            IdleTTL = 123,
            MaximumTTL = 123
          )
        ),
        SingleHeaderConfig = list(
          Header = "string",
          Value = "string"
        ),
        Type = "SingleWeight"|"SingleHeader"
      )
    )
  ),
  ETag = "string"
)

Request syntax

svc$update_continuous_deployment_policy(
  ContinuousDeploymentPolicyConfig = list(
    StagingDistributionDnsNames = list(
      Quantity = 123,
      Items = list(
        "string"
      )
    ),
    Enabled = TRUE|FALSE,
    TrafficConfig = list(
      SingleWeightConfig = list(
        Weight = 123.0,
        SessionStickinessConfig = list(
          IdleTTL = 123,
          MaximumTTL = 123
        )
      ),
      SingleHeaderConfig = list(
        Header = "string",
        Value = "string"
      ),
      Type = "SingleWeight"|"SingleHeader"
    )
  ),
  Id = "string",
  IfMatch = "string"
)