AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon CloudFront UpdateContinuousDeploymentPolicy API operation.

Syntax

Update-CFContinuousDeploymentPolicy
-Id <String>
-ContinuousDeploymentPolicyConfig_Enabled <Boolean>
-SingleHeaderConfig_Header <String>
-SessionStickinessConfig_IdleTTL <Int32>
-IfMatch <String>
-StagingDistributionDnsNames_Item <String[]>
-SessionStickinessConfig_MaximumTTL <Int32>
-StagingDistributionDnsNames_Quantity <Int32>
-TrafficConfig_Type <ContinuousDeploymentPolicyType>
-SingleHeaderConfig_Value <String>
-SingleWeightConfig_Weight <Single>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudFrontConfig>

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 GetContinuousDeploymentPolicyConfig to get the current configuration.
  2. Locally modify the fields in the continuous deployment policy configuration that you want to update.
  3. Use UpdateContinuousDeploymentPolicy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.

Parameters

-ClientConfig <AmazonCloudFrontConfig>
Amazon.PowerShell.Cmdlets.CF.AmazonCloudFrontClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContinuousDeploymentPolicyConfig_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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Id <String>
The identifier of the continuous deployment policy that you are updating.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-IfMatch <String>
The current version (ETag value) of the continuous deployment policy that you are updating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ContinuousDeploymentPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateContinuousDeploymentPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateContinuousDeploymentPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionStickinessConfig_IdleTTL <Int32>
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).The value must be less than or equal to MaximumTTL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_SingleWeightConfig_SessionStickinessConfig_IdleTTL
-SessionStickinessConfig_MaximumTTL <Int32>
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).The value must be less than or equal to IdleTTL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_SingleWeightConfig_SessionStickinessConfig_MaximumTTL
-SingleHeaderConfig_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-.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_SingleHeaderConfig_Header
-SingleHeaderConfig_Value <String>
The request header value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_SingleHeaderConfig_Value
-SingleWeightConfig_Weight <Single>
The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and .15.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_SingleWeightConfig_Weight
-StagingDistributionDnsNames_Item <String[]>
The CloudFront domain name of the staging distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_StagingDistributionDnsNames_Items
-StagingDistributionDnsNames_Quantity <Int32>
The number of CloudFront domain names in your staging distribution.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_StagingDistributionDnsNames_Quantity
-TrafficConfig_Type <ContinuousDeploymentPolicyType>
The type of traffic configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContinuousDeploymentPolicyConfig_TrafficConfig_Type

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CloudFront.Model.ContinuousDeploymentPolicy or Amazon.CloudFront.Model.UpdateContinuousDeploymentPolicyResponse
This cmdlet returns an Amazon.CloudFront.Model.ContinuousDeploymentPolicy object. The service call response (type Amazon.CloudFront.Model.UpdateContinuousDeploymentPolicyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z