AWS.Tools.CloudFront.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudFront</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet"> <summary> Creates signed cookies that grants universal access to private content until a given date (using a canned policy) or tailored access to private content based on an access time window and ip range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ResourceUri"> <summary> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <i>"http://" + distributionName + "/" + path</i> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <i>"https://"</i>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.KeyPairId"> <summary> The key pair id corresponding to the private key file given. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.PrivateKeyFile"> <summary> The private key file. RSA private key (.pem) are supported. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ExpiresOn"> <summary> The expiration date till which content can be accessed using the generated cookies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ActiveFrom"> <summary> The date from which content can be accessed using the generated cookies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.IpRange"> <summary> The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24). If not specified, a CIDR of 0.0.0.0/0 (i.e. no IP restriction) is used. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet"> <summary> Creates a signed URL that grants universal access to private content until a given date (using a canned policy) or tailored access to private content based on an access time window and ip range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ResourceUri"> <summary> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <i>"http://" + distributionName + "/" + path</i> (may also include URL parameters). For distributions with the HTTPS required protocol, the resource URL must start with <i>"https://"</i>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.KeyPairId"> <summary> The key pair id corresponding to the private key file supplied to the PrivateKeyFile parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.PrivateKeyFile"> <summary> The private key file. RSA private key (.pem) files are supported. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ExpiresOn"> <summary> The expiration date of the signed URL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ActiveFrom"> <summary> The date from which the URL can be accessed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.IpRange"> <summary> The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24). If not specified, a CIDR of 0.0.0.0/0 (i.e. no IP restriction) is used. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.AsString"> <summary> If set the cmdlet outputs the signed url as a simple string. The default is to wrap and emit the url as a System.Uri object. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet"> <summary> Add tags to a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.Tag"> <summary> <para> <para>A complex type that contains <c>Tag</c> elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.Resource"> <summary> <para> <para>An ARN of a CloudFront resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Resource parameter. The -PassThru parameter is deprecated, use -Select '^Resource' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet"> <summary> Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow. <para> After you create a staging distribution, you can use <c>UpdateDistribution</c> to modify the staging distribution's configuration. Then you can use <c>CreateContinuousDeploymentPolicy</c> to incrementally move traffic to the staging distribution. </para><para> This API operation requires the following IAM permissions: </para><ul><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html">GetDistribution</a></para></li><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html">CreateDistribution</a></para></li><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CopyDistribution.html">CopyDistribution</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.CallerReference"> <summary> <para> <para>A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.Enabled"> <summary> <para> <para>A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to <c>True</c>, the staging distribution is enabled. When you set this value to <c>False</c>, the staging distribution is disabled.</para><para>If you omit this field, the default value is <c>True</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.IfMatch"> <summary> <para> <para>The version identifier of the primary distribution whose configuration you are copying. This is the <c>ETag</c> value returned in the response to <c>GetDistribution</c> and <c>GetDistributionConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.PrimaryDistributionId"> <summary> <para> <para>The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use <c>ListDistributions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.Staging"> <summary> <para> <para>The type of distribution that your primary distribution will be copied to. The only valid value is <c>True</c>, indicating that you are copying to a staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CopyDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CopyDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.CopyCFDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyCmdlet"> <summary> Gets a cache policy, including the following metadata: <ul><li><para> The policy's identifier. </para></li><li><para> The date and time when the policy was last modified. </para></li></ul><para> To get a cache policy, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the cache policy is not attached to a cache behavior, you can get the identifier using <c>ListCachePolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the cache policy is not attached to a cache behavior, you can get the identifier using <c>ListCachePolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CachePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetCachePolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetCachePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyConfigCmdlet"> <summary> Gets a cache policy configuration. <para> To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the cache policy is not attached to a cache behavior, you can get the identifier using <c>ListCachePolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyConfigCmdlet.Id"> <summary> <para> <para>The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the cache policy is not attached to a cache behavior, you can get the identifier using <c>ListCachePolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CachePolicyConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetCachePolicyConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetCachePolicyConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet"> <summary> Gets a list of cache policies. <para> You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet.Type"> <summary> <para> <para>A filter to return only the specified kinds of cache policies. Valid values are:</para><ul><li><para><c>managed</c> – Returns only the managed policies created by Amazon Web Services.</para></li><li><para><c>custom</c> – Returns only the custom policies created in your Amazon Web Services account.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of cache policies that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CachePolicyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListCachePoliciesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListCachePoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCachePolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Get the information about an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> <para>The identity's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CloudFrontOriginAccessIdentity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet"> <summary> Get the configuration information about an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet.Id"> <summary> <para> <para>The identity's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CloudFrontOriginAccessIdentityConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityListCmdlet"> <summary> Lists origin access identities.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityListCmdlet.Marker"> <summary> <para> <para>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response (which is also the ID of the last identity on that page).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of origin access identities you want in the response body.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CloudFrontOriginAccessIdentityList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet"> <summary> Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own. <para> Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide <c>www.example.com</c> as input, the returned list can include <c>www.example.com</c> and the overlapping wildcard alternate domain name (<c>*.example.com</c>), if they exist. If you provide <c>*.example.com</c> as input, the returned list can include <c>*.example.com</c> and any alternate domain names covered by that wildcard (for example, <c>www.example.com</c>, <c>test.example.com</c>, <c>dev.example.com</c>, and so on), if they exist. </para><para> To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move">Moving an alternate domain name to a different distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.Alias"> <summary> <para> <para>The alias (also called a CNAME) to search for conflicting aliases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.DistributionId"> <summary> <para> <para>The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.MaxItem"> <summary> <para> <para>The maximum number of conflicting aliases that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConflictingAliasesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListConflictingAliasesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListConflictingAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFConflictingAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyCmdlet"> <summary> Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyCmdlet.Id"> <summary> <para> <para>The identifier of the continuous deployment policy that you are getting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyCmdlet.Select"> <summary> 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.GetContinuousDeploymentPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetContinuousDeploymentPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyConfigCmdlet"> <summary> Gets configuration information about a continuous deployment policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyConfigCmdlet.Id"> <summary> <para> <para>The identifier of the continuous deployment policy whose configuration you are getting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContinuousDeploymentPolicyConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetContinuousDeploymentPolicyConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetContinuousDeploymentPolicyConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyListCmdlet"> <summary> Gets a list of the continuous deployment policies in your Amazon Web Services account. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of continuous deployment policies that you want returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFContinuousDeploymentPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContinuousDeploymentPolicyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListContinuousDeploymentPoliciesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListContinuousDeploymentPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet"> <summary> Get the information about a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet.Id"> <summary> <para> <para>The distribution's ID. If the ID is empty, an empty distribution configuration is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Distribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet"> <summary> Get the configuration information about a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet.Id"> <summary> <para> <para>The distribution's ID. If the ID is empty, an empty distribution configuration is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetDistributionConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetDistributionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListCmdlet"> <summary> List CloudFront distributions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListCmdlet.Marker"> <summary> <para> <para>Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response (which is also the ID of the last distribution on that page).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distributions you want in the response body.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet"> <summary> List the distributions that are associated with a specified WAF web ACL.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.WebACLId"> <summary> <para> <para>The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL. </para><para>For WAFV2, this is the ARN of the web ACL, such as <c>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>.</para><para>For WAF Classic, this is the ID of the web ACL, such as <c>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.Marker"> <summary> <para> <para>Use <c>Marker</c> and <c>MaxItems</c> to control pagination of results. If you have more than <c>MaxItems</c> distributions that satisfy the request, the response includes a <c>NextMarker</c> element. To get the next page of results, submit another request. For the value of <c>Marker</c>, specify the value of <c>NextMarker</c> from the last response. (For the first request, omit <c>Marker</c>.)</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByWebACLIdResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByWebACLIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebACLId parameter. The -PassThru parameter is deprecated, use -Select '^WebACLId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet"> <summary> Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet.CachePolicyId"> <summary> <para> <para>The ID of the cache policy whose associated distribution IDs you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distribution IDs that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionIdList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByCachePolicyIdResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByCachePolicyIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByCachePolicyIdCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CachePolicyId parameter. The -PassThru parameter is deprecated, use -Select '^CachePolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet"> <summary> Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet.KeyGroupId"> <summary> <para> <para>The ID of the key group whose associated distribution IDs you are listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distribution IDs that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionIdList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByKeyGroupResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByKeyGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByKeyGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyGroupId parameter. The -PassThru parameter is deprecated, use -Select '^KeyGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet"> <summary> Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet.OriginRequestPolicyId"> <summary> <para> <para>The ID of the origin request policy whose associated distribution IDs you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distribution IDs that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionIdList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByOriginRequestPolicyIdResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByOriginRequestPolicyIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByOriginRequestPolicyIdCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginRequestPolicyId parameter. The -PassThru parameter is deprecated, use -Select '^OriginRequestPolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet"> <summary> Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration. <para> You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.RealtimeLogConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.RealtimeLogConfigName"> <summary> <para> <para>The name of the real-time log configuration whose associated distributions you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distributions that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByRealtimeLogConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByRealtimeLogConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByRealtimeLogConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RealtimeLogConfigName parameter. The -PassThru parameter is deprecated, use -Select '^RealtimeLogConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet"> <summary> Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet.ResponseHeadersPolicyId"> <summary> <para> <para>The ID of the response headers policy whose associated distribution IDs you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet.MaxItem"> <summary> <para> <para>The maximum number of distribution IDs that you want to get in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DistributionIdList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListDistributionsByResponseHeadersPolicyIdResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListDistributionsByResponseHeadersPolicyIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsByResponseHeadersPolicyIdCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResponseHeadersPolicyId parameter. The -PassThru parameter is deprecated, use -Select '^ResponseHeadersPolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionCmdlet"> <summary> Get the field-level encryption configuration information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionCmdlet.Id"> <summary> <para> <para>Request the ID for the field-level encryption configuration information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryption'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetFieldLevelEncryptionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetFieldLevelEncryptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigCmdlet"> <summary> Get the field-level encryption configuration information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigCmdlet.Id"> <summary> <para> <para>Request the ID for the field-level encryption configuration information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetFieldLevelEncryptionConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetFieldLevelEncryptionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigListCmdlet"> <summary> List all field-level encryption configurations that have been created in CloudFront for this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigListCmdlet.Marker"> <summary> <para> <para>Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response (which is also the ID of the last configuration on that page).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of field-level encryption configurations you want in the response body.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListFieldLevelEncryptionConfigsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListFieldLevelEncryptionConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionConfigListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileCmdlet"> <summary> Get the field-level encryption profile information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileCmdlet.Id"> <summary> <para> <para>Get the ID for the field-level encryption profile information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetFieldLevelEncryptionProfileResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetFieldLevelEncryptionProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileConfigCmdlet"> <summary> Get the field-level encryption profile configuration information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileConfigCmdlet.Id"> <summary> <para> <para>Get the ID for the field-level encryption profile configuration information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionProfileConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetFieldLevelEncryptionProfileConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetFieldLevelEncryptionProfileConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileListCmdlet"> <summary> Request a list of field-level encryption profiles that have been created in CloudFront for this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileListCmdlet.Marker"> <summary> <para> <para>Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response (which is also the ID of the last profile on that page).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of field-level encryption profiles you want in the response body. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionProfileList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListFieldLevelEncryptionProfilesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListFieldLevelEncryptionProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFieldLevelEncryptionProfileListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionCmdlet"> <summary> Gets the code of a CloudFront function. To get configuration information and metadata about a function, use <c>DescribeFunction</c>. <para> To get a function's code, you must provide the function's name and stage. To get these values, you can use <c>ListFunctions</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionCmdlet.Name"> <summary> <para> <para>The name of the function whose code you are getting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionCmdlet.Stage"> <summary> <para> <para>The function's stage, either <c>DEVELOPMENT</c> or <c>LIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionListCmdlet"> <summary> Gets a list of all CloudFront functions in your Amazon Web Services account. <para> You can optionally apply a filter to return only the functions that are in the specified stage, either <c>DEVELOPMENT</c> or <c>LIVE</c>. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionListCmdlet.Stage"> <summary> <para> <para>An optional filter to return only the functions that are in the specified stage, either <c>DEVELOPMENT</c> or <c>LIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of functions that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListFunctionsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListFunctionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionSummaryCmdlet"> <summary> Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use <c>GetFunction</c>. <para> To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use <c>ListFunctions</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionSummaryCmdlet.Name"> <summary> <para> <para>The name of the function that you are getting information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionSummaryCmdlet.Stage"> <summary> <para> <para>The function's stage, either <c>DEVELOPMENT</c> or <c>LIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DescribeFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.DescribeFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFFunctionSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet"> <summary> Get the information about an invalidation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.DistributionId"> <summary> <para> <para>The distribution's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.Id"> <summary> <para> <para>The identifier for the invalidation request, for example, <c>IDFDVBD632BHDS5</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Invalidation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetInvalidationResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetInvalidationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet"> <summary> Lists invalidation batches.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.DistributionId"> <summary> <para> <para>The distribution's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.Marker"> <summary> <para> <para>Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response. This value is the same as the ID of the last invalidation batch on that page.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of invalidation batches that you want in the response body.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InvalidationList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListInvalidationsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListInvalidationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupCmdlet"> <summary> Gets a key group, including the date and time when the key group was last modified. <para> To get a key group, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the key group is not referenced in a cache behavior, you can get the identifier using <c>ListKeyGroups</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupCmdlet.Id"> <summary> <para> <para>The identifier of the key group that you are getting. To get the identifier, use <c>ListKeyGroups</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetKeyGroupResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetKeyGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupConfigCmdlet"> <summary> Gets a key group configuration. <para> To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the key group is not referenced in a cache behavior, you can get the identifier using <c>ListKeyGroups</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupConfigCmdlet.Id"> <summary> <para> <para>The identifier of the key group whose configuration you are getting. To get the identifier, use <c>ListKeyGroups</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyGroupConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetKeyGroupConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetKeyGroupConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupListCmdlet"> <summary> Gets a list of key groups. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of key groups that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyGroupList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListKeyGroupsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListKeyGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreCmdlet"> <summary> Specifies the key value store and its configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreCmdlet.Name"> <summary> <para> <para>The name of the key value store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyValueStore'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DescribeKeyValueStoreResponse). Specifying the name of a property of type Amazon.CloudFront.Model.DescribeKeyValueStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet"> <summary> Specifies the key value stores to list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet.Status"> <summary> <para> <para>The status of the request for the key value stores list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet.Marker"> <summary> <para> <para>The marker associated with the key value stores list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items in the key value stores list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyValueStoreList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListKeyValueStoresResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListKeyValueStoresResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFKeyValueStoreListItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Status parameter. The -PassThru parameter is deprecated, use -Select '^Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFMonitoringSubscriptionCmdlet"> <summary> Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFMonitoringSubscriptionCmdlet.DistributionId"> <summary> <para> <para>The ID of the distribution that you are getting metrics information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFMonitoringSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringSubscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetMonitoringSubscriptionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetMonitoringSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFMonitoringSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlCmdlet"> <summary> Gets a CloudFront origin access control, including its unique identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlCmdlet.Id"> <summary> <para> <para>The unique identifier of the origin access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginAccessControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetOriginAccessControlResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetOriginAccessControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlConfigCmdlet"> <summary> Gets a CloudFront origin access control configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlConfigCmdlet.Id"> <summary> <para> <para>The unique identifier of the origin access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginAccessControlConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetOriginAccessControlConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetOriginAccessControlConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlListCmdlet"> <summary> Gets the list of CloudFront origin access controls in this Amazon Web Services account. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the next request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of origin access controls that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginAccessControlListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginAccessControlList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListOriginAccessControlsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListOriginAccessControlsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyCmdlet"> <summary> Gets an origin request policy, including the following metadata: <ul><li><para> The policy's identifier. </para></li><li><para> The date and time when the policy was last modified. </para></li></ul><para> To get an origin request policy, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <c>ListOriginRequestPolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <c>ListOriginRequestPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginRequestPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetOriginRequestPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetOriginRequestPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyConfigCmdlet"> <summary> Gets an origin request policy configuration. <para> To get an origin request policy configuration, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <c>ListOriginRequestPolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyConfigCmdlet.Id"> <summary> <para> <para>The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the origin request policy is not attached to a cache behavior, you can get the identifier using <c>ListOriginRequestPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginRequestPolicyConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetOriginRequestPolicyConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetOriginRequestPolicyConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet"> <summary> Gets a list of origin request policies. <para> You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet.Type"> <summary> <para> <para>A filter to return only the specified kinds of origin request policies. Valid values are:</para><ul><li><para><c>managed</c> – Returns only the managed policies created by Amazon Web Services.</para></li><li><para><c>custom</c> – Returns only the custom policies created in your Amazon Web Services account.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of origin request policies that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginRequestPolicyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListOriginRequestPoliciesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListOriginRequestPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFOriginRequestPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyCmdlet"> <summary> Gets a public key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyCmdlet.Id"> <summary> <para> <para>The identifier of the public key you are getting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetPublicKeyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetPublicKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyConfigCmdlet"> <summary> Gets a public key configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyConfigCmdlet.Id"> <summary> <para> <para>The identifier of the public key whose configuration you are getting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKeyConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetPublicKeyConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetPublicKeyConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyListCmdlet"> <summary> List all public keys that have been added to CloudFront for this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyListCmdlet.Marker"> <summary> <para> <para>Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the <c>Marker</c> to the value of the <c>NextMarker</c> from the current page's response (which is also the ID of the last public key on that page).</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of public keys you want in the response body.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKeyList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListPublicKeysResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListPublicKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigCmdlet"> <summary> Gets a real-time log configuration. <para> To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigCmdlet.ARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigCmdlet.Name"> <summary> <para> <para>The name of the real-time log configuration to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RealtimeLogConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetRealtimeLogConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetRealtimeLogConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigListCmdlet"> <summary> Gets a list of real-time log configurations. <para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of real-time log configurations that you want in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFRealtimeLogConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RealtimeLogConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListRealtimeLogConfigsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListRealtimeLogConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFResourceTagCmdlet"> <summary> List tags for a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResourceTagCmdlet.Resource"> <summary> <para> <para>An ARN of a CloudFront resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Resource parameter. The -PassThru parameter is deprecated, use -Select '^Resource' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyCmdlet"> <summary> Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified). <para> To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <c>ListResponseHeadersPolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyCmdlet.Id"> <summary> <para> <para>The identifier for the response headers policy.</para><para>If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <c>ListResponseHeadersPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseHeadersPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetResponseHeadersPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetResponseHeadersPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyConfigCmdlet"> <summary> Gets a response headers policy configuration. <para> To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <c>ListResponseHeadersPolicies</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyConfigCmdlet.Id"> <summary> <para> <para>The identifier for the response headers policy.</para><para>If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using <c>ListDistributions</c> or <c>GetDistribution</c>. If the response headers policy is not attached to a cache behavior, you can get the identifier using <c>ListResponseHeadersPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseHeadersPolicyConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetResponseHeadersPolicyConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetResponseHeadersPolicyConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet"> <summary> Gets a list of response headers policies. <para> You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. </para><para> You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the <c>NextMarker</c> value from the current response as the <c>Marker</c> value in the subsequent request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet.Type"> <summary> <para> <para>A filter to get only the specified kind of response headers policies. Valid values are:</para><ul><li><para><c>managed</c> – Gets only the managed policies created by Amazon Web Services.</para></li><li><para><c>custom</c> – Gets only the custom policies created in your Amazon Web Services account.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet.Marker"> <summary> <para> <para>Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of <c>NextMarker</c> from the current page's response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet.MaxItem"> <summary> <para> <para>The maximum number of response headers policies that you want to get in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseHeadersPolicyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListResponseHeadersPoliciesResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListResponseHeadersPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFResponseHeadersPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet"> <summary> Gets information about a specified RTMP distribution, including the distribution configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet.Id"> <summary> <para> <para>The streaming distribution's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingDistribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetStreamingDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetStreamingDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet"> <summary> Get the configuration information about a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet.Id"> <summary> <para> <para>The streaming distribution's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingDistributionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.GetStreamingDistributionConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.GetStreamingDistributionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionListCmdlet"> <summary> List streaming distributions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionListCmdlet.Marker"> <summary> <para> <para>The value that you provided for the <c>Marker</c> request parameter.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionListCmdlet.MaxItem"> <summary> <para> <para>The value that you provided for the <c>MaxItems</c> request parameter.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingDistributionList.Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.ListStreamingDistributionsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.ListStreamingDistributionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet"> <summary> Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution. <para> With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution. </para><para> To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move">Moving an alternate domain name to a different distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet.Alias"> <summary> <para> <para>The alias (also known as a CNAME) to add to the target distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet.TargetDistributionId"> <summary> <para> <para>The ID of the distribution that you're associating the alias with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.AssociateAliasResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.MoveCFAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet"> <summary> Creates a cache policy. <para> After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following: </para><ul><li><para> The values that CloudFront includes in the <i>cache key</i>. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. </para></li><li><para> The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. </para></li></ul><para> The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but <i>not</i> include them in the cache key, use <c>OriginRequestPolicy</c>. </para><para> For more information about cache policies, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">Controlling the cache key</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CachePolicyConfig_Comment"> <summary> <para> <para>A comment to describe the cache policy. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CookiesConfig_CookieBehavior"> <summary> <para> <para>Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any cookies that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the cookies in viewer requests that are listed in the <c>CookieNames</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i><b>except</b></i> for those that are listed in the <c>CookieNames</c> type, which are not included.</para></li><li><para><c>all</c> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CachePolicyConfig_DefaultTTL"> <summary> <para> <para>The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does <i>not</i> send <c>Cache-Control</c> or <c>Expires</c> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default value for this field is 86400 seconds (one day). If the value of <c>MinTTL</c> is more than 86400 seconds, then the default value for this field is the same as the value of <c>MinTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.ParametersInCacheKeyAndForwardedToOrigin_EnableAcceptEncodingBrotli"> <summary> <para> <para>A flag that can affect whether the <c>Accept-Encoding</c> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</para><para>This field is related to the <c>EnableAcceptEncodingGzip</c> field. If one or both of these fields is <c>true</c><i>and</i> the viewer request includes the <c>Accept-Encoding</c> header, then CloudFront does the following:</para><ul><li><para>Normalizes the value of the viewer's <c>Accept-Encoding</c> header</para></li><li><para>Includes the normalized header in the cache key</para></li><li><para>Includes the normalized header in the request to the origin, if a request is necessary</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you set this value to <c>true</c>, and this cache behavior also has an origin request policy attached, do not include the <c>Accept-Encoding</c> header in the origin request policy. CloudFront always includes the <c>Accept-Encoding</c> header in origin requests when the value of this field is <c>true</c>, so including this header in an origin request policy has no effect.</para><para>If both of these fields are <c>false</c>, then CloudFront treats the <c>Accept-Encoding</c> header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add <c>Accept-Encoding</c> to the headers whitelist like any other HTTP header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.ParametersInCacheKeyAndForwardedToOrigin_EnableAcceptEncodingGzip"> <summary> <para> <para>A flag that can affect whether the <c>Accept-Encoding</c> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</para><para>This field is related to the <c>EnableAcceptEncodingBrotli</c> field. If one or both of these fields is <c>true</c><i>and</i> the viewer request includes the <c>Accept-Encoding</c> header, then CloudFront does the following:</para><ul><li><para>Normalizes the value of the viewer's <c>Accept-Encoding</c> header</para></li><li><para>Includes the normalized header in the cache key</para></li><li><para>Includes the normalized header in the request to the origin, if a request is necessary</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you set this value to <c>true</c>, and this cache behavior also has an origin request policy attached, do not include the <c>Accept-Encoding</c> header in the origin request policy. CloudFront always includes the <c>Accept-Encoding</c> header in origin requests when the value of this field is <c>true</c>, so including this header in an origin request policy has no effect.</para><para>If both of these fields are <c>false</c>, then CloudFront treats the <c>Accept-Encoding</c> header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add <c>Accept-Encoding</c> to the headers whitelist like any other HTTP header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.HeadersConfig_HeaderBehavior"> <summary> <para> <para>Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any headers that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the HTTP headers that are listed in the <c>Headers</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Cookies_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.QueryStrings_Item"> <summary> <para> <para>A list of query string names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CachePolicyConfig_MaxTTL"> <summary> <para> <para>The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends <c>Cache-Control</c> or <c>Expires</c> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default value for this field is 31536000 seconds (one year). If the value of <c>MinTTL</c> or <c>DefaultTTL</c> is more than 31536000 seconds, then the default value for this field is the same as the value of <c>DefaultTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CachePolicyConfig_MinTTL"> <summary> <para> <para>The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.CachePolicyConfig_Name"> <summary> <para> <para>A unique name to identify the cache policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Cookies_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.QueryStrings_Quantity"> <summary> <para> <para>The number of query string names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.QueryStringsConfig_QueryStringBehavior"> <summary> <para> <para>Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any query strings that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the query strings in viewer requests that are listed in the <c>QueryStringNames</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i><b>except</b></i> those that are listed in the <c>QueryStringNames</c> type, which are not included.</para></li><li><para><c>all</c> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateCachePolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateCachePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCachePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>CloudFrontOriginAccessIdentityConfig</c> object), a new origin access identity is created.</para><para>If the <c>CallerReference</c> is a value already sent in a previous identity request, and the content of the <c>CloudFrontOriginAccessIdentityConfig</c> is identical to the original request (ignoring white space), the response includes the same information returned to the original request.</para><para>If the <c>CallerReference</c> is a value you already sent in a previous request to create an identity, but the content of the <c>CloudFrontOriginAccessIdentityConfig</c> is different from the original request, CloudFront returns a <c>CloudFrontOriginAccessIdentityAlreadyExists</c> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> <para>A comment to describe the origin access identity. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet"> <summary> Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions. <para> To use a continuous deployment policy, first use <c>CopyDistribution</c> to create a staging distribution, then use <c>UpdateDistribution</c> to modify the staging distribution's configuration. </para><para> After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.ContinuousDeploymentPolicyConfig_Enabled"> <summary> <para> <para>A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is <c>true</c>, this policy is enabled and in effect. When this value is <c>false</c>, this policy is not enabled and has no effect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.SingleHeaderConfig_Header"> <summary> <para> <para>The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix <c>aws-cf-cd-</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.SessionStickinessConfig_IdleTTL"> <summary> <para> <para>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).</para><para>The value must be less than or equal to <c>MaximumTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.StagingDistributionDnsNames_Item"> <summary> <para> <para>The CloudFront domain name of the staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.SessionStickinessConfig_MaximumTTL"> <summary> <para> <para>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).</para><para>The value must be greater than or equal to <c>IdleTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.StagingDistributionDnsNames_Quantity"> <summary> <para> <para>The number of CloudFront domain names in your staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.TrafficConfig_Type"> <summary> <para> <para>The type of traffic configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.SingleHeaderConfig_Value"> <summary> <para> <para>The request header value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.SingleWeightConfig_Weight"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateContinuousDeploymentPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateContinuousDeploymentPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFContinuousDeploymentPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet"> <summary> Creates a CloudFront distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a>, provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (<c>us-east-1</c>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_CachePolicyId"> <summary> <para> <para>The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>A <c>DefaultCacheBehavior</c> must include either a <c>CachePolicyId</c> or <c>ForwardedValues</c>. We recommend that you use a <c>CachePolicyId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>DistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_CloudFrontDefaultCertificate"> <summary> <para> <para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, set this field to <c>true</c>.</para><para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), set this field to <c>false</c> and specify values for the following fields:</para><ul><li><para><c>ACMCertificateArn</c> or <c>IAMCertificateId</c> (specify a value for one, not both)</para></li><li><para><c>MinimumProtocolVersion</c></para></li><li><para><c>SSLSupportMethod</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> <para>A comment to describe the distribution. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_Compress"> <summary> <para> <para>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_ContinuousDeploymentPolicyId"> <summary> <para> <para>The identifier of a continuous deployment policy. For more information, see <c>CreateContinuousDeploymentPolicy</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <c>index.html</c>) when a viewer requests the root URL for your distribution (<c>https://www.example.com</c>) instead of an object in your distribution (<c>https://www.example.com/product-description.html</c>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <c>index.html</c>. Don't add a <c>/</c> before the object name.</para><para>If you don't want to specify a default root object when you create a distribution, include an empty <c>DefaultRootObject</c> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <c>DefaultRootObject</c> element.</para><para>To replace the default root object, update the distribution configuration and specify the new object.</para><para>For more information about the default root object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedKeyGroups_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Enabled"> <summary> <para> <para>From this field, you can enable or disable the selected distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <c>false</c> for <c>Enabled</c>, and specify empty <c>Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c>, <c>prefix</c>, and <c>IncludeCookies</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_FieldLevelEncryptionId"> <summary> <para> <para>The value of <c>ID</c> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Cookies_Forward"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <c>WhitelistedNames</c> complex type.</para><para>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <c>Forward</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <c>http2</c>. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</para><para>For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).</para><para>For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see <a href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration">Connection Migration</a> at RFC 9000. For more information about supported TLSv1.3 ciphers, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html">Supported protocols and ciphers between viewers and CloudFront</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_IncludeCookie"> <summary> <para> <para>Specifies whether you want CloudFront to include cookies in access logs, specify <c>true</c> for <c>IncludeCookies</c>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <c>false</c> for <c>IncludeCookies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_IsIPV6Enabled"> <summary> <para> <para>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <c>true</c>. If you specify <c>false</c>, CloudFront responds to IPv6 DNS requests with the DNS response code <c>NOERROR</c> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.</para><para>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <c>IpAddress</c> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</para><ul><li><para>You enable IPv6 for the distribution</para></li><li><para>You're using alternate domain names in the URLs for your objects</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Route 53 Amazon Web Services Integration Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CacheBehaviors_Item"> <summary> <para> <para>Optional: A complex type that contains cache behaviors for this distribution. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <c>CustomErrorResponse</c> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CachedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for <c>CachedMethods</c> include <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c>, depending on which caching option you choose. For more information, see the preceding section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.AllowedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.WhitelistedNames_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.QueryStringCacheKeys_Item"> <summary> <para> <para>A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If <c>Quantity</c> is 0, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.FunctionAssociations_Item"> <summary> <para> <para>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the <c>LIVE</c> stage to associate them with a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.LambdaFunctionAssociations_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains <c>LambdaFunctionAssociation</c> items for this cache behavior. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedKeyGroups_Item"> <summary> <para> <para>A list of key groups identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.OriginGroups_Item"> <summary> <para> <para>The items (origin groups) in a distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Origins_Item"> <summary> <para> <para>A list of origins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> <para>A complex type that contains a <c>Location</c> element for each country in which you want CloudFront either to distribute your content (<c>whitelist</c>) or not distribute your content (<c>blacklist</c>).</para><para>The <c>Location</c> element is a two-letter, uppercase country code for a country that you want to include in your <c>blacklist</c> or <c>whitelist</c>. Include one <c>Location</c> element for each country.</para><para>CloudFront and <c>MaxMind</c> both use <c>ISO 3166</c> country codes. For the current list of countries and the corresponding codes, see <c>ISO 3166-1-alpha-2</c> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</para><ul><li><para>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</para></li><li><para>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>On the CloudFront console, this setting is called <b>Security Policy</b>.</para></note><para>When you're using SNI only (you set <c>SSLSupportMethod</c> to <c>sni-only</c>), you must specify <c>TLSv1</c> or higher.</para><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c> (you set <c>CloudFrontDefaultCertificate</c> to <c>true</c>), CloudFront automatically sets the security policy to <c>TLSv1</c> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_OriginRequestPolicyId"> <summary> <para> <para>The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log <c>filenames</c> for this distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_PriceClass"> <summary> <para> <para>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <c>PriceClass_All</c>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <c>PriceClass_All</c>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</para><para>For more information about price classes, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see <a href="http://aws.amazon.com/cloudfront/pricing/">Amazon CloudFront Pricing</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CacheBehaviors_Quantity"> <summary> <para> <para>The number of cache behaviors for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CustomErrorResponses_Quantity"> <summary> <para> <para>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CachedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <c>2</c> (for caching responses to <c>GET</c> and <c>HEAD</c> requests) and <c>3</c> (for caching responses to <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.AllowedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <c>GET</c> and <c>HEAD</c> requests), 3 (for <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests) and 7 (for <c>GET, HEAD, OPTIONS, PUT, PATCH, POST</c>, and <c>DELETE</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <c>whitelisted</c> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.FunctionAssociations_Quantity"> <summary> <para> <para>The number of CloudFront functions in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda@Edge function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedKeyGroups_Quantity"> <summary> <para> <para>The number of key groups in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.OriginGroups_Quantity"> <summary> <para> <para>The number of origin groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Origins_Quantity"> <summary> <para> <para>The number of origins for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <c>enabled</c>, this is the number of countries in your <c>whitelist</c> or <c>blacklist</c>. Otherwise, when it is not enabled, <c>Quantity</c> is <c>0</c>, and you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include query strings in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <c>QueryString</c> and on the values that you specify for <c>QueryStringCacheKeys</c>, if any:</para><para>If you specify true for <c>QueryString</c> and you don't specify any values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</para><para>If you specify true for <c>QueryString</c> and you specify one or more values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</para><para>If you specify false for <c>QueryString</c>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_RealtimeLogConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_ResponseHeadersPolicyId"> <summary> <para> <para>The identifier for a response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><c>none</c>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><c>blacklist</c>: The <c>Location</c> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><c>whitelist</c>: The <c>Location</c> elements specify the countries in which you want CloudFront to distribute your content.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_SmoothStreaming"> <summary> <para> <para>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. If you specify <c>true</c> for <c>SmoothStreaming</c>, you can still distribute other content using this cache behavior if the content matches the value of <c>PathPattern</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><c>sni-only</c> – The distribution accepts HTTPS connections from only viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a>. This is recommended. Most browsers and clients support SNI.</para></li><li><para><c>vip</c> – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</para></li><li><para><c>static-ip</c> - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the <a href="https://console.aws.amazon.com/support/home">Amazon Web Services Support Center</a>.</para></li></ul><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, don't set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Staging"> <summary> <para> <para>A Boolean that indicates whether this is a staging distribution. When this value is <c>true</c>, this is a staging distribution. When this value is <c>false</c>, this is not a staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <c>ID</c> for the origin that you want CloudFront to route requests to when they use the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_ViewerProtocolPolicy"> <summary> <para> <para>The protocol that viewers can use to access the files in the origin specified by <c>TargetOriginId</c> when a request matches the path pattern in <c>PathPattern</c>. You can specify the following options:</para><ul><li><para><c>allow-all</c>: Viewers can use HTTP or HTTPS.</para></li><li><para><c>redirect-to-https</c>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</para></li><li><para><c>https-only</c>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</para></li></ul><para>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_WebACLId"> <summary> <para> <para>A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example <c>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>. To specify a web ACL created using WAF Classic, use the ACL ID, for example <c>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>.</para><para>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_Certificate"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_CertificateSource"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_DefaultTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>DefaultTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MaxTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MinTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>You must specify <c>0</c> for <c>MinTTL</c> if you configure CloudFront to forward all headers to your origin (under <c>Headers</c>, if you specify <c>1</c> for <c>Quantity</c> and <c>*</c> for <c>Name</c>).</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet"> <summary> Create a new distribution with tags. This API operation requires the following IAM permissions: <ul><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html">CreateDistribution</a></para></li><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_TagResource.html">TagResource</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a>, provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (<c>us-east-1</c>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_CachePolicyId"> <summary> <para> <para>The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>A <c>DefaultCacheBehavior</c> must include either a <c>CachePolicyId</c> or <c>ForwardedValues</c>. We recommend that you use a <c>CachePolicyId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>DistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_CloudFrontDefaultCertificate"> <summary> <para> <para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, set this field to <c>true</c>.</para><para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), set this field to <c>false</c> and specify values for the following fields:</para><ul><li><para><c>ACMCertificateArn</c> or <c>IAMCertificateId</c> (specify a value for one, not both)</para></li><li><para><c>MinimumProtocolVersion</c></para></li><li><para><c>SSLSupportMethod</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_Comment"> <summary> <para> <para>A comment to describe the distribution. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_Compress"> <summary> <para> <para>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_ContinuousDeploymentPolicyId"> <summary> <para> <para>The identifier of a continuous deployment policy. For more information, see <c>CreateContinuousDeploymentPolicy</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <c>index.html</c>) when a viewer requests the root URL for your distribution (<c>https://www.example.com</c>) instead of an object in your distribution (<c>https://www.example.com/product-description.html</c>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <c>index.html</c>. Don't add a <c>/</c> before the object name.</para><para>If you don't want to specify a default root object when you create a distribution, include an empty <c>DefaultRootObject</c> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <c>DefaultRootObject</c> element.</para><para>To replace the default root object, update the distribution configuration and specify the new object.</para><para>For more information about the default root object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedKeyGroups_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_Enabled"> <summary> <para> <para>From this field, you can enable or disable the selected distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <c>false</c> for <c>Enabled</c>, and specify empty <c>Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c>, <c>prefix</c>, and <c>IncludeCookies</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_FieldLevelEncryptionId"> <summary> <para> <para>The value of <c>ID</c> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Cookies_Forward"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <c>WhitelistedNames</c> complex type.</para><para>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <c>Forward</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <c>http2</c>. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</para><para>For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).</para><para>For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see <a href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration">Connection Migration</a> at RFC 9000. For more information about supported TLSv1.3 ciphers, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html">Supported protocols and ciphers between viewers and CloudFront</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Logging_IncludeCookie"> <summary> <para> <para>Specifies whether you want CloudFront to include cookies in access logs, specify <c>true</c> for <c>IncludeCookies</c>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <c>false</c> for <c>IncludeCookies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_IsIPV6Enabled"> <summary> <para> <para>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <c>true</c>. If you specify <c>false</c>, CloudFront responds to IPv6 DNS requests with the DNS response code <c>NOERROR</c> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.</para><para>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <c>IpAddress</c> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</para><ul><li><para>You enable IPv6 for the distribution</para></li><li><para>You're using alternate domain names in the URLs for your objects</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Route 53 Amazon Web Services Integration Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CacheBehaviors_Item"> <summary> <para> <para>Optional: A complex type that contains cache behaviors for this distribution. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <c>CustomErrorResponse</c> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CachedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for <c>CachedMethods</c> include <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c>, depending on which caching option you choose. For more information, see the preceding section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.AllowedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.WhitelistedNames_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.QueryStringCacheKeys_Item"> <summary> <para> <para>A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If <c>Quantity</c> is 0, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.FunctionAssociations_Item"> <summary> <para> <para>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the <c>LIVE</c> stage to associate them with a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.LambdaFunctionAssociations_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains <c>LambdaFunctionAssociation</c> items for this cache behavior. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedKeyGroups_Item"> <summary> <para> <para>A list of key groups identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.OriginGroups_Item"> <summary> <para> <para>The items (origin groups) in a distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Origins_Item"> <summary> <para> <para>A list of origins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.GeoRestriction_Item"> <summary> <para> <para>A complex type that contains a <c>Location</c> element for each country in which you want CloudFront either to distribute your content (<c>whitelist</c>) or not distribute your content (<c>blacklist</c>).</para><para>The <c>Location</c> element is a two-letter, uppercase country code for a country that you want to include in your <c>blacklist</c> or <c>whitelist</c>. Include one <c>Location</c> element for each country.</para><para>CloudFront and <c>MaxMind</c> both use <c>ISO 3166</c> country codes. For the current list of countries and the corresponding codes, see <c>ISO 3166-1-alpha-2</c> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Tags_Item"> <summary> <para> <para>A complex type that contains <c>Tag</c> elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</para><ul><li><para>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</para></li><li><para>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>On the CloudFront console, this setting is called <b>Security Policy</b>.</para></note><para>When you're using SNI only (you set <c>SSLSupportMethod</c> to <c>sni-only</c>), you must specify <c>TLSv1</c> or higher.</para><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c> (you set <c>CloudFrontDefaultCertificate</c> to <c>true</c>), CloudFront automatically sets the security policy to <c>TLSv1</c> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_OriginRequestPolicyId"> <summary> <para> <para>The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log <c>filenames</c> for this distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_PriceClass"> <summary> <para> <para>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <c>PriceClass_All</c>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <c>PriceClass_All</c>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</para><para>For more information about price classes, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see <a href="http://aws.amazon.com/cloudfront/pricing/">Amazon CloudFront Pricing</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CacheBehaviors_Quantity"> <summary> <para> <para>The number of cache behaviors for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CustomErrorResponses_Quantity"> <summary> <para> <para>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CachedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <c>2</c> (for caching responses to <c>GET</c> and <c>HEAD</c> requests) and <c>3</c> (for caching responses to <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.AllowedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <c>GET</c> and <c>HEAD</c> requests), 3 (for <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests) and 7 (for <c>GET, HEAD, OPTIONS, PUT, PATCH, POST</c>, and <c>DELETE</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <c>whitelisted</c> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.FunctionAssociations_Quantity"> <summary> <para> <para>The number of CloudFront functions in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda@Edge function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedKeyGroups_Quantity"> <summary> <para> <para>The number of key groups in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.OriginGroups_Quantity"> <summary> <para> <para>The number of origin groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Origins_Quantity"> <summary> <para> <para>The number of origins for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <c>enabled</c>, this is the number of countries in your <c>whitelist</c> or <c>blacklist</c>. Otherwise, when it is not enabled, <c>Quantity</c> is <c>0</c>, and you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ForwardedValues_QueryString"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include query strings in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <c>QueryString</c> and on the values that you specify for <c>QueryStringCacheKeys</c>, if any:</para><para>If you specify true for <c>QueryString</c> and you don't specify any values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</para><para>If you specify true for <c>QueryString</c> and you specify one or more values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</para><para>If you specify false for <c>QueryString</c>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_RealtimeLogConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_ResponseHeadersPolicyId"> <summary> <para> <para>The identifier for a response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><c>none</c>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><c>blacklist</c>: The <c>Location</c> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><c>whitelist</c>: The <c>Location</c> elements specify the countries in which you want CloudFront to distribute your content.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_SmoothStreaming"> <summary> <para> <para>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. If you specify <c>true</c> for <c>SmoothStreaming</c>, you can still distribute other content using this cache behavior if the content matches the value of <c>PathPattern</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><c>sni-only</c> – The distribution accepts HTTPS connections from only viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a>. This is recommended. Most browsers and clients support SNI.</para></li><li><para><c>vip</c> – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</para></li><li><para><c>static-ip</c> - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the <a href="https://console.aws.amazon.com/support/home">Amazon Web Services Support Center</a>.</para></li></ul><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, don't set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_Staging"> <summary> <para> <para>A Boolean that indicates whether this is a staging distribution. When this value is <c>true</c>, this is a staging distribution. When this value is <c>false</c>, this is not a staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <c>ID</c> for the origin that you want CloudFront to route requests to when they use the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_ViewerProtocolPolicy"> <summary> <para> <para>The protocol that viewers can use to access the files in the origin specified by <c>TargetOriginId</c> when a request matches the path pattern in <c>PathPattern</c>. You can specify the following options:</para><ul><li><para><c>allow-all</c>: Viewers can use HTTP or HTTPS.</para></li><li><para><c>redirect-to-https</c>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</para></li><li><para><c>https-only</c>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</para></li></ul><para>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_WebACLId"> <summary> <para> <para>A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example <c>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>. To specify a web ACL created using WAF Classic, use the ACL ID, for example <c>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>.</para><para>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_Certificate"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_CertificateSource"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_DefaultTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>DefaultTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MaxTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MinTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>You must specify <c>0</c> for <c>MinTTL</c> if you configure CloudFront to forward all headers to your origin (under <c>Headers</c>, if you specify <c>1</c> for <c>Quantity</c> and <c>*</c> for <c>Name</c>).</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateDistributionWithTagsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateDistributionWithTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionConfigCmdlet"> <summary> Create a new field-level encryption configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionConfigCmdlet.FieldLevelEncryptionConfig"> <summary> <para> <para>The request to create a new field-level encryption configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateFieldLevelEncryptionConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateFieldLevelEncryptionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FieldLevelEncryptionConfig parameter. The -PassThru parameter is deprecated, use -Select '^FieldLevelEncryptionConfig' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet"> <summary> Create a field-level encryption profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_CallerReference"> <summary> <para> <para>A unique number that ensures that the request can't be replayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_Comment"> <summary> <para> <para>An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.EncryptionEntities_Item"> <summary> <para> <para>An array of field patterns in a field-level encryption content type-profile mapping. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_Name"> <summary> <para> <para>Profile name for the field-level encryption profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.EncryptionEntities_Quantity"> <summary> <para> <para>Number of field pattern items in a field-level encryption content type-profile mapping.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateFieldLevelEncryptionProfileResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateFieldLevelEncryptionProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FieldLevelEncryptionProfileConfig_Name parameter. The -PassThru parameter is deprecated, use -Select '^FieldLevelEncryptionProfileConfig_Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFieldLevelEncryptionProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet"> <summary> Creates a CloudFront function. <para> To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function. </para><para> When you create a function, it's in the <c>DEVELOPMENT</c> stage. In this stage, you can test the function with <c>TestFunction</c>, and update it with <c>UpdateFunction</c>. </para><para> When you're ready to use your function with a CloudFront distribution, use <c>PublishFunction</c> to copy the function from the <c>DEVELOPMENT</c> stage to <c>LIVE</c>. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.FunctionConfig_Comment"> <summary> <para> <para>A comment to describe the function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.FunctionCode"> <summary> <para> <para>The function code. For more information about writing a CloudFront function, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html">Writing function code for CloudFront Functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.KeyValueStoreAssociations_Item"> <summary> <para> <para>The items of the key value store association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.Name"> <summary> <para> <para>A name to identify the function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.KeyValueStoreAssociations_Quantity"> <summary> <para> <para>The quantity of key value store associations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.FunctionConfig_Runtime"> <summary> <para> <para>The function's runtime environment version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFFunctionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet"> <summary> Create a new invalidation. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html">Invalidating files</a> in the <i>Amazon CloudFront Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.InvalidationBatch_CallerReference"> <summary> <para> <para>A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for <c>CallerReference</c> and change other values in the request as applicable. One way to ensure that the value of <c>CallerReference</c> is unique is to use a <c>timestamp</c>, for example, <c>20120301090000</c>.</para><para>If you make a second invalidation request with the same value for <c>CallerReference</c>, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same <c>CallerReference</c>.</para><para>If <c>CallerReference</c> is a value you already sent in a previous invalidation batch request but the content of any <c>Path</c> is different from the original request, CloudFront returns an <c>InvalidationBatchAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.DistributionId"> <summary> <para> <para>The distribution's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Paths_Item"> <summary> <para> <para>A complex type that contains a list of the paths that you want to invalidate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Paths_Quantity"> <summary> <para> <para>The number of invalidation paths specified for the objects that you want to invalidate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateInvalidationResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateInvalidationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet"> <summary> Creates a key group that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">CloudFront signed URLs and signed cookies</a>. <para> To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">Serving private content</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.KeyGroupConfig_Comment"> <summary> <para> <para>A comment to describe the key group. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.KeyGroupConfig_Item"> <summary> <para> <para>A list of the identifiers of the public keys in the key group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.KeyGroupConfig_Name"> <summary> <para> <para>A name to identify the key group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateKeyGroupResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateKeyGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyGroupConfig_Name parameter. The -PassThru parameter is deprecated, use -Select '^KeyGroupConfig_Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet"> <summary> Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid <c>ImportSource</c> that you own. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.Comment"> <summary> <para> <para>The comment of the key value store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.Name"> <summary> <para> <para>The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.ImportSource_SourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the import source for the key value store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.ImportSource_SourceType"> <summary> <para> <para>The source type of the import source for the key value store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateKeyValueStoreResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateKeyValueStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFKeyValueStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet"> <summary> Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost. <para> For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional">Viewing additional CloudFront distribution metrics</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet.DistributionId"> <summary> <para> <para>The ID of the distribution that you are enabling metrics for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet.RealtimeMetricsSubscriptionConfig_RealtimeMetricsSubscriptionStatus"> <summary> <para> <para>A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringSubscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateMonitoringSubscriptionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateMonitoringSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFMonitoringSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet"> <summary> Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. <para> This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. </para><para> For more information about using a CloudFront origin access control, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html">Restricting access to an Amazon Web Services origin</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.OriginAccessControlConfig_Description"> <summary> <para> <para>A description of the origin access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.OriginAccessControlConfig_Name"> <summary> <para> <para>A name to identify the origin access control. You can specify up to 64 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.OriginAccessControlConfig_OriginAccessControlOriginType"> <summary> <para> <para>The type of origin that this origin access control is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.OriginAccessControlConfig_SigningBehavior"> <summary> <para> <para>Specifies which requests CloudFront signs (adds authentication information to). Specify <c>always</c> for the most common use case. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings">origin access control advanced settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>This field can have one of the following values:</para><ul><li><para><c>always</c> – CloudFront signs all origin requests, overwriting the <c>Authorization</c> header from the viewer request if one exists.</para></li><li><para><c>never</c> – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.</para></li><li><para><c>no-override</c> – If the viewer request doesn't contain the <c>Authorization</c> header, then CloudFront signs the origin request. If the viewer request contains the <c>Authorization</c> header, then CloudFront doesn't sign the origin request and instead passes along the <c>Authorization</c> header from the viewer request. <b>WARNING: To pass along the <c>Authorization</c> header from the viewer request, you <i>must</i> add the <c>Authorization</c> header to a <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">cache policy</a> for all cache behaviors that use origins associated with this origin access control.</b></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.OriginAccessControlConfig_SigningProtocol"> <summary> <para> <para>The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is <c>sigv4</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateOriginAccessControlResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateOriginAccessControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OriginAccessControlConfig_Name parameter. The -PassThru parameter is deprecated, use -Select '^OriginAccessControlConfig_Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginAccessControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet"> <summary> Creates an origin request policy. <para> After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following: </para><ul><li><para> The request body and the URL path (without the domain name) from the viewer request. </para></li><li><para> The headers that CloudFront automatically includes in every origin request, including <c>Host</c>, <c>User-Agent</c>, and <c>X-Amz-Cf-Id</c>. </para></li><li><para> All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront. </para></li></ul><para> CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use <c>CachePolicy</c>. </para><para> For more information about origin request policies, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html">Controlling origin requests</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.OriginRequestPolicyConfig_Comment"> <summary> <para> <para>A comment to describe the origin request policy. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.CookiesConfig_CookieBehavior"> <summary> <para> <para>Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any cookies that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the cookies in viewer requests that are listed in the <c>CookieNames</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>all</c> – All cookies in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All cookies in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>CookieNames</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.HeadersConfig_HeaderBehavior"> <summary> <para> <para>Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any headers that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the HTTP headers that are listed in the <c>Headers</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allViewer</c> – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allViewerAndWhitelistCloudFront</c> – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the <c>Headers</c> type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.</para></li><li><para><c>allExcept</c> – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>Headers</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Cookies_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.QueryStrings_Item"> <summary> <para> <para>A list of query string names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.OriginRequestPolicyConfig_Name"> <summary> <para> <para>A unique name to identify the origin request policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Cookies_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.QueryStrings_Quantity"> <summary> <para> <para>The number of query string names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.QueryStringsConfig_QueryStringBehavior"> <summary> <para> <para>Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any query strings that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the query strings in viewer requests that are listed in the <c>QueryStringNames</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>all</c> – All query strings in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All query strings in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>QueryStringNames</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateOriginRequestPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateOriginRequestPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFOriginRequestPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet"> <summary> Uploads a public key to CloudFront that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">signed URLs and signed cookies</a>, or with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html">field-level encryption</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_CallerReference"> <summary> <para> <para>A string included in the request to help make sure that the request can't be replayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_Comment"> <summary> <para> <para>A comment to describe the public key. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_EncodedKey"> <summary> <para> <para>The public key that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">signed URLs and signed cookies</a>, or with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html">field-level encryption</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_Name"> <summary> <para> <para>A name to help identify the public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreatePublicKeyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreatePublicKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PublicKeyConfig_Name parameter. The -PassThru parameter is deprecated, use -Select '^PublicKeyConfig_Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet"> <summary> Creates a real-time log configuration. <para> After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream. </para><para> For more information about real-time log configurations, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.EndPoint"> <summary> <para> <para>Contains information about the Amazon Kinesis data stream where you are sending real-time log data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.Field"> <summary> <para> <para>A list of fields to include in each real-time log record.</para><para>For more information about fields, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields">Real-time log configuration fields</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.Name"> <summary> <para> <para>A unique name to identify this real-time log configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.SamplingRate"> <summary> <para> <para>The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RealtimeLogConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateRealtimeLogConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateRealtimeLogConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFRealtimeLogConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet"> <summary> Creates a response headers policy. <para> A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers. </para><para> After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. </para><para> For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html">Adding or removing HTTP headers in CloudFront responses</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.CorsConfig_AccessControlAllowCredential"> <summary> <para> <para>A Boolean that CloudFront uses as the value for the <c>Access-Control-Allow-Credentials</c> HTTP response header.</para><para>For more information about the <c>Access-Control-Allow-Credentials</c> HTTP response header, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials">Access-Control-Allow-Credentials</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.CorsConfig_AccessControlMaxAgeSec"> <summary> <para> <para>A number that CloudFront uses as the value for the <c>Access-Control-Max-Age</c> HTTP response header.</para><para>For more information about the <c>Access-Control-Max-Age</c> HTTP response header, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age">Access-Control-Max-Age</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_AccessControlMaxAgeSec"> <summary> <para> <para>A number that CloudFront uses as the value for the <c>max-age</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ResponseHeadersPolicyConfig_Comment"> <summary> <para> <para>A comment to describe the response headers policy.</para><para>The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ContentSecurityPolicy_ContentSecurityPolicy"> <summary> <para> <para>The policy directives and their values that CloudFront includes as values for the <c>Content-Security-Policy</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ServerTimingHeadersConfig_Enabled"> <summary> <para> <para>A Boolean that determines whether CloudFront adds the <c>Server-Timing</c> header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.FrameOptions_FrameOption"> <summary> <para> <para>The value of the <c>X-Frame-Options</c> HTTP response header. Valid values are <c>DENY</c> and <c>SAMEORIGIN</c>.</para><para>For more information about these values, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options">X-Frame-Options</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_IncludeSubdomain"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>includeSubDomains</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowHeaders_Item"> <summary> <para> <para>The list of HTTP header names. You can specify <c>*</c> to allow all headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowMethods_Item"> <summary> <para> <para>The list of HTTP methods. Valid values are:</para><ul><li><para><c>GET</c></para></li><li><para><c>DELETE</c></para></li><li><para><c>HEAD</c></para></li><li><para><c>OPTIONS</c></para></li><li><para><c>PATCH</c></para></li><li><para><c>POST</c></para></li><li><para><c>PUT</c></para></li><li><para><c>ALL</c></para></li></ul><para><c>ALL</c> is a special value that includes all of the listed HTTP methods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowOrigins_Item"> <summary> <para> <para>The list of origins (domain names). You can specify <c>*</c> to allow all origins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlExposeHeaders_Item"> <summary> <para> <para>The list of HTTP headers. You can specify <c>*</c> to expose all headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.CustomHeadersConfig_Item"> <summary> <para> <para>The list of HTTP response headers and their values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.RemoveHeadersConfig_Item"> <summary> <para> <para>The list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.XSSProtection_ModeBlock"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>mode=block</c> directive in the <c>X-XSS-Protection</c> header.</para><para>For more information about this directive, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ResponseHeadersPolicyConfig_Name"> <summary> <para> <para>A name to identify the response headers policy.</para><para>The name must be unique for response headers policies in this Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.CorsConfig_OriginOverride"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ContentSecurityPolicy_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Content-Security-Policy</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ContentTypeOptions_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-Content-Type-Options</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.FrameOptions_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-Frame-Options</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ReferrerPolicy_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Referrer-Policy</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Strict-Transport-Security</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.XSSProtection_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-XSS-Protection</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_Preload"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>preload</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.XSSProtection_Protection"> <summary> <para> <para>A Boolean that determines the value of the <c>X-XSS-Protection</c> HTTP response header. When this setting is <c>true</c>, the value of the <c>X-XSS-Protection</c> header is <c>1</c>. When this setting is <c>false</c>, the value of the <c>X-XSS-Protection</c> header is <c>0</c>.</para><para>For more information about these settings, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowHeaders_Quantity"> <summary> <para> <para>The number of HTTP header names in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowMethods_Quantity"> <summary> <para> <para>The number of HTTP methods in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlAllowOrigins_Quantity"> <summary> <para> <para>The number of origins in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.AccessControlExposeHeaders_Quantity"> <summary> <para> <para>The number of HTTP headers in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.CustomHeadersConfig_Quantity"> <summary> <para> <para>The number of HTTP response headers in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.RemoveHeadersConfig_Quantity"> <summary> <para> <para>The number of HTTP header names in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ReferrerPolicy_ReferrerPolicy"> <summary> <para> <para>The value of the <c>Referrer-Policy</c> HTTP response header. Valid values are:</para><ul><li><para><c>no-referrer</c></para></li><li><para><c>no-referrer-when-downgrade</c></para></li><li><para><c>origin</c></para></li><li><para><c>origin-when-cross-origin</c></para></li><li><para><c>same-origin</c></para></li><li><para><c>strict-origin</c></para></li><li><para><c>strict-origin-when-cross-origin</c></para></li><li><para><c>unsafe-url</c></para></li></ul><para>For more information about these values, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy">Referrer-Policy</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.XSSProtection_ReportUri"> <summary> <para> <para>A reporting URI, which CloudFront uses as the value of the <c>report</c> directive in the <c>X-XSS-Protection</c> header.</para><para>You cannot specify a <c>ReportUri</c> when <c>ModeBlock</c> is <c>true</c>.</para><para>For more information about using a reporting URL, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.ServerTimingHeadersConfig_SamplingRate"> <summary> <para> <para>A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the <c>Server-Timing</c> header to. When you set the sampling rate to 100, CloudFront adds the <c>Server-Timing</c> header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateResponseHeadersPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateResponseHeadersPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResponseHeadersPolicyConfig_Name parameter. The -PassThru parameter is deprecated, use -Select '^ResponseHeadersPolicyConfig_Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFResponseHeadersPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet"> <summary> This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, <a href="http://forums.aws.amazon.com/ann.jspa?annID=7356">read the announcement</a> on the Amazon CloudFront discussion forum. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>StreamingDistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.S3Origin_DomainName"> <summary> <para> <para>The DNS name of the Amazon S3 origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_Enabled"> <summary> <para> <para>Whether the streaming distribution is enabled to accept user requests for content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <c>false</c> for <c>Enabled</c>, and specify <c>empty Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c> and <c>Prefix</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.S3Origin_OriginAccessIdentity"> <summary> <para> <para>The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</para><para>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <c>OriginAccessIdentity</c> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <c>OriginAccessIdentity</c> element.</para><para>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i> Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_PriceClass"> <summary> <para> <para>A complex type that contains information about price class for this streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateStreamingDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateStreamingDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the S3Origin_DomainName parameter. The -PassThru parameter is deprecated, use -Select '^S3Origin_DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet"> <summary> This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, <a href="http://forums.aws.amazon.com/ann.jspa?annID=7356">read the announcement</a> on the Amazon CloudFront discussion forum. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.StreamingDistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>StreamingDistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.StreamingDistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.S3Origin_DomainName"> <summary> <para> <para>The DNS name of the Amazon S3 origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.StreamingDistributionConfig_Enabled"> <summary> <para> <para>Whether the streaming distribution is enabled to accept user requests for content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <c>false</c> for <c>Enabled</c>, and specify <c>empty Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c> and <c>Prefix</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Tags_Item"> <summary> <para> <para>A complex type that contains <c>Tag</c> elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.S3Origin_OriginAccessIdentity"> <summary> <para> <para>The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</para><para>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <c>OriginAccessIdentity</c> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <c>OriginAccessIdentity</c> element.</para><para>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i> Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.StreamingDistributionConfig_PriceClass"> <summary> <para> <para>A complex type that contains information about price class for this streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.CreateStreamingDistributionWithTagsResponse). Specifying the name of a property of type Amazon.CloudFront.Model.CreateStreamingDistributionWithTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet"> <summary> Publishes a CloudFront function by copying the function code from the <c>DEVELOPMENT</c> stage to <c>LIVE</c>. This automatically updates all cache behaviors that are using this function to use the newly published copy in the <c>LIVE</c> stage. <para> When a function is published to the <c>LIVE</c> stage, you can attach the function to a distribution's cache behavior, using the function's Amazon Resource Name (ARN). </para><para> To publish a function, you must provide the function's name and version (<c>ETag</c> value). To get these values, you can use <c>ListFunctions</c> and <c>DescribeFunction</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the function that you are publishing, which you can get using <c>DescribeFunction</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet.Name"> <summary> <para> <para>The name of the function that you are publishing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.PublishFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.PublishFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.PublishCFFunctionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet"> <summary> Deletes a cache policy. <para> You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy. </para><para> To delete a cache policy, you must provide the policy's identifier and version. To get these values, you can use <c>ListCachePolicies</c> or <c>GetCachePolicy</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the cache policy that you are deleting. To get the identifier, you can use <c>ListCachePolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the cache policy that you are deleting. The version is the cache policy's <c>ETag</c> value, which you can get using <c>ListCachePolicies</c>, <c>GetCachePolicy</c>, or <c>GetCachePolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteCachePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCachePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Delete an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> <para>The origin access identity's ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header you received from a previous <c>GET</c> or <c>PUT</c> request. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet"> <summary> Deletes a continuous deployment policy. <para> You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet.Id"> <summary> <para> <para>The identifier of the continuous deployment policy that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the continuous deployment policy that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteContinuousDeploymentPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFContinuousDeploymentPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet"> <summary> Delete a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.Id"> <summary> <para> <para>The distribution ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when you disabled the distribution. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteDistributionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet"> <summary> Remove a field-level encryption configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet.Id"> <summary> <para> <para>The ID of the configuration you want to delete from CloudFront.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the configuration identity to delete. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteFieldLevelEncryptionConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet"> <summary> Remove a field-level encryption profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet.Id"> <summary> <para> <para>Request the ID of the profile you want to delete from CloudFront.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the profile to delete. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteFieldLevelEncryptionProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFieldLevelEncryptionProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet"> <summary> Deletes a CloudFront function. <para> You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function. </para><para> To delete a function, you must provide the function's name and version (<c>ETag</c> value). To get these values, you can use <c>ListFunctions</c> and <c>DescribeFunction</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the function that you are deleting, which you can get using <c>DescribeFunction</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet.Name"> <summary> <para> <para>The name of the function that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteFunctionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFFunctionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet"> <summary> Deletes a key group. <para> You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group. </para><para> To delete a key group, you must provide the key group's identifier and version. To get these values, use <c>ListKeyGroups</c> followed by <c>GetKeyGroup</c> or <c>GetKeyGroupConfig</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet.Id"> <summary> <para> <para>The identifier of the key group that you are deleting. To get the identifier, use <c>ListKeyGroups</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet.IfMatch"> <summary> <para> <para>The version of the key group that you are deleting. The version is the key group's <c>ETag</c> value. To get the <c>ETag</c>, use <c>GetKeyGroup</c> or <c>GetKeyGroupConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteKeyGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet"> <summary> Specifies the key value store to delete. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet.IfMatch"> <summary> <para> <para>The key value store to delete, if a match occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet.Name"> <summary> <para> <para>The name of the key value store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteKeyValueStoreResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFKeyValueStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFMonitoringSubscriptionCmdlet"> <summary> Disables additional CloudWatch metrics for the specified CloudFront distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFMonitoringSubscriptionCmdlet.DistributionId"> <summary> <para> <para>The ID of the distribution that you are disabling metrics for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFMonitoringSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteMonitoringSubscriptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFMonitoringSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DistributionId parameter. The -PassThru parameter is deprecated, use -Select '^DistributionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFMonitoringSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet"> <summary> Deletes a CloudFront origin access control. <para> You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet.Id"> <summary> <para> <para>The unique identifier of the origin access control that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the origin access control that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteOriginAccessControlResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginAccessControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet"> <summary> Deletes an origin request policy. <para> You cannot delete an origin request policy if it's attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy. </para><para> To delete an origin request policy, you must provide the policy's identifier and version. To get the identifier, you can use <c>ListOriginRequestPolicies</c> or <c>GetOriginRequestPolicy</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use <c>ListOriginRequestPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the origin request policy that you are deleting. The version is the origin request policy's <c>ETag</c> value, which you can get using <c>ListOriginRequestPolicies</c>, <c>GetOriginRequestPolicy</c>, or <c>GetOriginRequestPolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteOriginRequestPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFOriginRequestPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet"> <summary> Remove a public key you previously added to CloudFront. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet.Id"> <summary> <para> <para>The ID of the public key you want to remove from CloudFront.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the public key identity to delete. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeletePublicKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFPublicKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet"> <summary> Deletes a real-time log configuration. <para> You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration. </para><para> To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet.ARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet.Name"> <summary> <para> <para>The name of the real-time log configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteRealtimeLogConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFRealtimeLogConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet"> <summary> Remove tags from a CloudFront resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html">Tagging a distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.TagKey"> <summary> <para> <para>A complex type that contains <c>Tag</c> key elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.Resource"> <summary> <para> <para>An ARN of a CloudFront resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Resource parameter. The -PassThru parameter is deprecated, use -Select '^Resource' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet"> <summary> Deletes a response headers policy. <para> You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy. </para><para> To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use <c>ListResponseHeadersPolicies</c> or <c>GetResponseHeadersPolicy</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet.Id"> <summary> <para> <para>The identifier for the response headers policy that you are deleting.</para><para>To get the identifier, you can use <c>ListResponseHeadersPolicies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the response headers policy that you are deleting.</para><para>The version is the response headers policy's <c>ETag</c> value, which you can get using <c>ListResponseHeadersPolicies</c>, <c>GetResponseHeadersPolicy</c>, or <c>GetResponseHeadersPolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteResponseHeadersPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResponseHeadersPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet"> <summary> Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps. <para><b>To delete an RTMP distribution using the CloudFront API</b>: </para><ol><li><para> Disable the RTMP distribution. </para></li><li><para> Submit a <c>GET Streaming Distribution Config</c> request to get the current configuration and the <c>Etag</c> header for the distribution. </para></li><li><para> Update the XML document that was returned in the response to your <c>GET Streaming Distribution Config</c> request to change the value of <c>Enabled</c> to <c>false</c>. </para></li><li><para> Submit a <c>PUT Streaming Distribution Config</c> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <c>If-Match</c> header to the value of the <c>ETag</c> header that CloudFront returned when you submitted the <c>GET Streaming Distribution Config</c> request in Step 2. </para></li><li><para> Review the response to the <c>PUT Streaming Distribution Config</c> request to confirm that the distribution was successfully disabled. </para></li><li><para> Submit a <c>GET Streaming Distribution Config</c> request to confirm that your changes have propagated. When propagation is complete, the value of <c>Status</c> is <c>Deployed</c>. </para></li><li><para> Submit a <c>DELETE Streaming Distribution</c> request. Set the value of the HTTP <c>If-Match</c> header to the value of the <c>ETag</c> header that CloudFront returned when you submitted the <c>GET Streaming Distribution Config</c> request in Step 2. </para></li><li><para> Review the response to your <c>DELETE Streaming Distribution</c> request to confirm that the distribution was successfully deleted. </para></li></ol><para> For information about deleting a distribution using the CloudFront console, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.Id"> <summary> <para> <para>The distribution ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when you disabled the streaming distribution. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.DeleteStreamingDistributionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet"> <summary> Tests a CloudFront function. <para> To test a function, you provide an <i>event object</i> that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function">Testing functions</a> in the <i>Amazon CloudFront Developer Guide</i>. </para><para> To test a function, you provide the function's name and version (<c>ETag</c> value) along with the event object. To get the function's name and version, you can use <c>ListFunctions</c> and <c>DescribeFunction</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet.EventObject"> <summary> <para> <para>The event object to test the function with. For more information about the structure of the event object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function">Testing functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the function that you are testing, which you can get using <c>DescribeFunction</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet.Name"> <summary> <para> <para>The name of the function that you are testing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet.Stage"> <summary> <para> <para>The stage of the function that you are testing, either <c>DEVELOPMENT</c> or <c>LIVE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.TestCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TestResult'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.TestFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.TestFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet"> <summary> Updates a cache policy configuration. <para> When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration: </para><ol><li><para> Use <c>GetCachePolicyConfig</c> to get the current configuration. </para></li><li><para> Locally modify the fields in the cache policy configuration that you want to update. </para></li><li><para> Call <c>UpdateCachePolicy</c> by providing the entire cache policy configuration, including the fields that you modified and those that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CachePolicyConfig_Comment"> <summary> <para> <para>A comment to describe the cache policy. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CookiesConfig_CookieBehavior"> <summary> <para> <para>Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any cookies that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the cookies in viewer requests that are listed in the <c>CookieNames</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i><b>except</b></i> for those that are listed in the <c>CookieNames</c> type, which are not included.</para></li><li><para><c>all</c> – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CachePolicyConfig_DefaultTTL"> <summary> <para> <para>The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does <i>not</i> send <c>Cache-Control</c> or <c>Expires</c> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default value for this field is 86400 seconds (one day). If the value of <c>MinTTL</c> is more than 86400 seconds, then the default value for this field is the same as the value of <c>MinTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.ParametersInCacheKeyAndForwardedToOrigin_EnableAcceptEncodingBrotli"> <summary> <para> <para>A flag that can affect whether the <c>Accept-Encoding</c> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</para><para>This field is related to the <c>EnableAcceptEncodingGzip</c> field. If one or both of these fields is <c>true</c><i>and</i> the viewer request includes the <c>Accept-Encoding</c> header, then CloudFront does the following:</para><ul><li><para>Normalizes the value of the viewer's <c>Accept-Encoding</c> header</para></li><li><para>Includes the normalized header in the cache key</para></li><li><para>Includes the normalized header in the request to the origin, if a request is necessary</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you set this value to <c>true</c>, and this cache behavior also has an origin request policy attached, do not include the <c>Accept-Encoding</c> header in the origin request policy. CloudFront always includes the <c>Accept-Encoding</c> header in origin requests when the value of this field is <c>true</c>, so including this header in an origin request policy has no effect.</para><para>If both of these fields are <c>false</c>, then CloudFront treats the <c>Accept-Encoding</c> header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add <c>Accept-Encoding</c> to the headers whitelist like any other HTTP header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.ParametersInCacheKeyAndForwardedToOrigin_EnableAcceptEncodingGzip"> <summary> <para> <para>A flag that can affect whether the <c>Accept-Encoding</c> HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.</para><para>This field is related to the <c>EnableAcceptEncodingBrotli</c> field. If one or both of these fields is <c>true</c><i>and</i> the viewer request includes the <c>Accept-Encoding</c> header, then CloudFront does the following:</para><ul><li><para>Normalizes the value of the viewer's <c>Accept-Encoding</c> header</para></li><li><para>Includes the normalized header in the cache key</para></li><li><para>Includes the normalized header in the request to the origin, if a request is necessary</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects">Compression support</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you set this value to <c>true</c>, and this cache behavior also has an origin request policy attached, do not include the <c>Accept-Encoding</c> header in the origin request policy. CloudFront always includes the <c>Accept-Encoding</c> header in origin requests when the value of this field is <c>true</c>, so including this header in an origin request policy has no effect.</para><para>If both of these fields are <c>false</c>, then CloudFront treats the <c>Accept-Encoding</c> header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add <c>Accept-Encoding</c> to the headers whitelist like any other HTTP header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.HeadersConfig_HeaderBehavior"> <summary> <para> <para>Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any headers that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the HTTP headers that are listed in the <c>Headers</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior's <c>CachePolicyId</c> field in the response to <c>GetDistributionConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the cache policy that you are updating. The version is returned in the cache policy's <c>ETag</c> field in the response to <c>GetCachePolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Cookies_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.QueryStrings_Item"> <summary> <para> <para>A list of query string names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CachePolicyConfig_MaxTTL"> <summary> <para> <para>The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends <c>Cache-Control</c> or <c>Expires</c> headers with the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default value for this field is 31536000 seconds (one year). If the value of <c>MinTTL</c> or <c>DefaultTTL</c> is more than 31536000 seconds, then the default value for this field is the same as the value of <c>DefaultTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CachePolicyConfig_MinTTL"> <summary> <para> <para>The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.CachePolicyConfig_Name"> <summary> <para> <para>A unique name to identify the cache policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Cookies_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.QueryStrings_Quantity"> <summary> <para> <para>The number of query string names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.QueryStringsConfig_QueryStringBehavior"> <summary> <para> <para>Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any query strings that are listed in an <c>OriginRequestPolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the query strings in viewer requests that are listed in the <c>QueryStringNames</c> type are included in the cache key and in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, <i><b>except</b></i> those that are listed in the <c>QueryStringNames</c> type, which are not included.</para></li><li><para><c>all</c> – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CachePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateCachePolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateCachePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCachePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Update an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>CloudFrontOriginAccessIdentityConfig</c> object), a new origin access identity is created.</para><para>If the <c>CallerReference</c> is a value already sent in a previous identity request, and the content of the <c>CloudFrontOriginAccessIdentityConfig</c> is identical to the original request (ignoring white space), the response includes the same information returned to the original request.</para><para>If the <c>CallerReference</c> is a value you already sent in a previous request to create an identity, but the content of the <c>CloudFrontOriginAccessIdentityConfig</c> is different from the original request, CloudFront returns a <c>CloudFrontOriginAccessIdentityAlreadyExists</c> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> <para>A comment to describe the origin access identity. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> <para>The identity's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the identity's configuration. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CloudFrontOriginAccessIdentity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet"> <summary> 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. <para> 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: </para><ol><li><para> Use <c>GetContinuousDeploymentPolicyConfig</c> to get the current configuration. </para></li><li><para> Locally modify the fields in the continuous deployment policy configuration that you want to update. </para></li><li><para> Use <c>UpdateContinuousDeploymentPolicy</c>, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.ContinuousDeploymentPolicyConfig_Enabled"> <summary> <para> <para>A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is <c>true</c>, this policy is enabled and in effect. When this value is <c>false</c>, this policy is not enabled and has no effect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.SingleHeaderConfig_Header"> <summary> <para> <para>The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix <c>aws-cf-cd-</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.Id"> <summary> <para> <para>The identifier of the continuous deployment policy that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.SessionStickinessConfig_IdleTTL"> <summary> <para> <para>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).</para><para>The value must be less than or equal to <c>MaximumTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the continuous deployment policy that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.StagingDistributionDnsNames_Item"> <summary> <para> <para>The CloudFront domain name of the staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.SessionStickinessConfig_MaximumTTL"> <summary> <para> <para>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).</para><para>The value must be greater than or equal to <c>IdleTTL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.StagingDistributionDnsNames_Quantity"> <summary> <para> <para>The number of CloudFront domain names in your staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.TrafficConfig_Type"> <summary> <para> <para>The type of traffic configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.SingleHeaderConfig_Value"> <summary> <para> <para>The request header value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.SingleWeightConfig_Weight"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFContinuousDeploymentPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet"> <summary> Updates the configuration for a CloudFront distribution. <para> The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an <c>UpdateDistribution</c> request to make the updates. </para><para><b>To update a web distribution using the CloudFront API</b></para><ol><li><para> Use <c>GetDistributionConfig</c> to get the current configuration, including the version identifier (<c>ETag</c>). </para></li><li><para> Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions: </para><ul><li><para> You must rename the <c>ETag</c> field to <c>IfMatch</c>, leaving the value unchanged. (Set the value of <c>IfMatch</c> to the value of <c>ETag</c>, then remove the <c>ETag</c> field.) </para></li><li><para> You can't change the value of <c>CallerReference</c>. </para></li></ul></li><li><para> Submit an <c>UpdateDistribution</c> request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an <c>UpdateDistribution</c> request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html">Certificate Manager (ACM)</a>, provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (<c>us-east-1</c>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_CachePolicyId"> <summary> <para> <para>The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>A <c>DefaultCacheBehavior</c> must include either a <c>CachePolicyId</c> or <c>ForwardedValues</c>. We recommend that you use a <c>CachePolicyId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>DistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_CloudFrontDefaultCertificate"> <summary> <para> <para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, set this field to <c>true</c>.</para><para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), set this field to <c>false</c> and specify values for the following fields:</para><ul><li><para><c>ACMCertificateArn</c> or <c>IAMCertificateId</c> (specify a value for one, not both)</para></li><li><para><c>MinimumProtocolVersion</c></para></li><li><para><c>SSLSupportMethod</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> <para>A comment to describe the distribution. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_Compress"> <summary> <para> <para>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_ContinuousDeploymentPolicyId"> <summary> <para> <para>The identifier of a continuous deployment policy. For more information, see <c>CreateContinuousDeploymentPolicy</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <c>index.html</c>) when a viewer requests the root URL for your distribution (<c>https://www.example.com</c>) instead of an object in your distribution (<c>https://www.example.com/product-description.html</c>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <c>index.html</c>. Don't add a <c>/</c> before the object name.</para><para>If you don't want to specify a default root object when you create a distribution, include an empty <c>DefaultRootObject</c> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <c>DefaultRootObject</c> element.</para><para>To replace the default root object, update the distribution configuration and specify the new object.</para><para>For more information about the default root object, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedKeyGroups_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Enabled"> <summary> <para> <para>From this field, you can enable or disable the selected distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <c>false</c> for <c>Enabled</c>, and specify empty <c>Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c>, <c>prefix</c>, and <c>IncludeCookies</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_FieldLevelEncryptionId"> <summary> <para> <para>The value of <c>ID</c> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Cookies_Forward"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include cookies in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <c>WhitelistedNames</c> complex type.</para><para>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <c>Forward</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <c>http2</c>. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</para><para>For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).</para><para>For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see <a href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration">Connection Migration</a> at RFC 9000. For more information about supported TLSv1.3 ciphers, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html">Supported protocols and ciphers between viewers and CloudFront</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Identity and Access Management (IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <c>MinimumProtocolVersion</c> and <c>SSLSupportMethod</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Id"> <summary> <para> <para>The distribution's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the distribution's configuration. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_IncludeCookie"> <summary> <para> <para>Specifies whether you want CloudFront to include cookies in access logs, specify <c>true</c> for <c>IncludeCookies</c>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <c>false</c> for <c>IncludeCookies</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_IsIPV6Enabled"> <summary> <para> <para>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <c>true</c>. If you specify <c>false</c>, CloudFront responds to IPv6 DNS requests with the DNS response code <c>NOERROR</c> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.</para><para>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <c>IpAddress</c> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</para><ul><li><para>You enable IPv6 for the distribution</para></li><li><para>You're using alternate domain names in the URLs for your objects</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Route 53 Amazon Web Services Integration Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CacheBehaviors_Item"> <summary> <para> <para>Optional: A complex type that contains cache behaviors for this distribution. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <c>CustomErrorResponse</c> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CachedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for <c>CachedMethods</c> include <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c>, depending on which caching option you choose. For more information, see the preceding section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.AllowedMethods_Item"> <summary> <para> <para>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.WhitelistedNames_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.QueryStringCacheKeys_Item"> <summary> <para> <para>A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If <c>Quantity</c> is 0, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.FunctionAssociations_Item"> <summary> <para> <para>The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the <c>LIVE</c> stage to associate them with a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.LambdaFunctionAssociations_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains <c>LambdaFunctionAssociation</c> items for this cache behavior. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedKeyGroups_Item"> <summary> <para> <para>A list of key groups identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.OriginGroups_Item"> <summary> <para> <para>The items (origin groups) in a distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Origins_Item"> <summary> <para> <para>A list of origins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> <para>A complex type that contains a <c>Location</c> element for each country in which you want CloudFront either to distribute your content (<c>whitelist</c>) or not distribute your content (<c>blacklist</c>).</para><para>The <c>Location</c> element is a two-letter, uppercase country code for a country that you want to include in your <c>blacklist</c> or <c>whitelist</c>. Include one <c>Location</c> element for each country.</para><para>CloudFront and <c>MaxMind</c> both use <c>ISO 3166</c> country codes. For the current list of countries and the corresponding codes, see <c>ISO 3166-1-alpha-2</c> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</para><ul><li><para>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</para></li><li><para>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy">Security Policy</a> and <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>On the CloudFront console, this setting is called <b>Security Policy</b>.</para></note><para>When you're using SNI only (you set <c>SSLSupportMethod</c> to <c>sni-only</c>), you must specify <c>TLSv1</c> or higher.</para><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c> (you set <c>CloudFrontDefaultCertificate</c> to <c>true</c>), CloudFront automatically sets the security policy to <c>TLSv1</c> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_OriginRequestPolicyId"> <summary> <para> <para>The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html">Using the managed origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log <c>filenames</c> for this distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_PriceClass"> <summary> <para> <para>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <c>PriceClass_All</c>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <c>PriceClass_All</c>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</para><para>For more information about price classes, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see <a href="http://aws.amazon.com/cloudfront/pricing/">Amazon CloudFront Pricing</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CacheBehaviors_Quantity"> <summary> <para> <para>The number of cache behaviors for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CustomErrorResponses_Quantity"> <summary> <para> <para>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <c>Quantity</c> is <c>0</c>, you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CachedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <c>2</c> (for caching responses to <c>GET</c> and <c>HEAD</c> requests) and <c>3</c> (for caching responses to <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.AllowedMethods_Quantity"> <summary> <para> <para>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <c>GET</c> and <c>HEAD</c> requests), 3 (for <c>GET</c>, <c>HEAD</c>, and <c>OPTIONS</c> requests) and 7 (for <c>GET, HEAD, OPTIONS, PUT, PATCH, POST</c>, and <c>DELETE</c> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <c>whitelisted</c> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.FunctionAssociations_Quantity"> <summary> <para> <para>The number of CloudFront functions in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda@Edge function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedKeyGroups_Quantity"> <summary> <para> <para>The number of key groups in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.OriginGroups_Quantity"> <summary> <para> <para>The number of origin groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Origins_Quantity"> <summary> <para> <para>The number of origins for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <c>enabled</c>, this is the number of countries in your <c>whitelist</c> or <c>blacklist</c>. Otherwise, when it is not enabled, <c>Quantity</c> is <c>0</c>, and you can omit <c>Items</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <para> <para>This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.</para><para>If you want to include query strings in the cache key, use a cache policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy">Creating origin request policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <c>QueryString</c> and on the values that you specify for <c>QueryStringCacheKeys</c>, if any:</para><para>If you specify true for <c>QueryString</c> and you don't specify any values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</para><para>If you specify true for <c>QueryString</c> and you specify one or more values for <c>QueryStringCacheKeys</c>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</para><para>If you specify false for <c>QueryString</c>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_RealtimeLogConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html">Real-time logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_ResponseHeadersPolicyId"> <summary> <para> <para>The identifier for a response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><c>none</c>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><c>blacklist</c>: The <c>Location</c> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><c>whitelist</c>: The <c>Location</c> elements specify the countries in which you want CloudFront to distribute your content.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_SmoothStreaming"> <summary> <para> <para>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <c>true</c>; if not, specify <c>false</c>. If you specify <c>true</c> for <c>SmoothStreaming</c>, you can still distribute other content using this cache behavior if the content matches the value of <c>PathPattern</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <c>Aliases</c> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><c>sni-only</c> – The distribution accepts HTTPS connections from only viewers that support <a href="https://en.wikipedia.org/wiki/Server_Name_Indication">server name indication (SNI)</a>. This is recommended. Most browsers and clients support SNI.</para></li><li><para><c>vip</c> – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</para></li><li><para><c>static-ip</c> - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the <a href="https://console.aws.amazon.com/support/home">Amazon Web Services Support Center</a>.</para></li></ul><para>If the distribution uses the CloudFront domain name such as <c>d111111abcdef8.cloudfront.net</c>, don't set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Staging"> <summary> <para> <para>A Boolean that indicates whether this is a staging distribution. When this value is <c>true</c>, this is a staging distribution. When this value is <c>false</c>, this is not a staging distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <c>ID</c> for the origin that you want CloudFront to route requests to when they use the default cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_ViewerProtocolPolicy"> <summary> <para> <para>The protocol that viewers can use to access the files in the origin specified by <c>TargetOriginId</c> when a request matches the path pattern in <c>PathPattern</c>. You can specify the following options:</para><ul><li><para><c>allow-all</c>: Viewers can use HTTP or HTTPS.</para></li><li><para><c>redirect-to-https</c>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</para></li><li><para><c>https-only</c>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</para></li></ul><para>For more information about requiring the HTTPS protocol, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html">Requiring HTTPS Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><note><para>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing Cache Expiration</a> in the <i>Amazon CloudFront Developer Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_WebACLId"> <summary> <para> <para>A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example <c>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>. To specify a web ACL created using WAF Classic, use the ACL ID, for example <c>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</c>.</para><para>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_Certificate"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_CertificateSource"> <summary> <para> <para>This field is deprecated. Use one of the following fields instead:</para><ul><li><para><c>ACMCertificateArn</c></para></li><li><para><c>IAMCertificateId</c></para></li><li><para><c>CloudFrontDefaultCertificate</c></para></li></ul> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_DefaultTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>DefaultTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MaxTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <c>Cache-Control max-age</c>, <c>Cache-Control s-maxage</c>, and <c>Expires</c> to objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <para> <para>This field is deprecated. We recommend that you use the <c>MinTTL</c> field in a cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html">Managing How Long Content Stays in an Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>You must specify <c>0</c> for <c>MinTTL</c> if you configure CloudFront to forward all headers to your origin (under <c>Headers</c>, if you specify <c>1</c> for <c>Quantity</c> and <c>*</c> for <c>Name</c>).</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Distribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet"> <summary> Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its <c>Aliases</c> (also known as alternate domain names or CNAMEs) and <c>ContinuousDeploymentPolicyId</c> value, but otherwise its configuration is overwritten to match the staging distribution. <para> You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution. </para><para> This API operation requires the following IAM permissions: </para><ul><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html">GetDistribution</a></para></li><li><para><a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.Id"> <summary> <para> <para>The identifier of the primary distribution to which you are copying a staging distribution's configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.IfMatch"> <summary> <para> <para>The current versions (<c>ETag</c> values) of both primary and staging distributions. Provide these in the following format:</para><para><c><primary ETag>, <staging ETag></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.StagingDistributionId"> <summary> <para> <para>The identifier of the staging distribution whose configuration you are copying to the primary distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Distribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateDistributionWithStagingConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateDistributionWithStagingConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionWithStagingConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet"> <summary> Update a field-level encryption configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.FieldLevelEncryptionConfig"> <summary> <para> <para>Request to update a field-level encryption configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.Id"> <summary> <para> <para>The ID of the configuration you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the configuration identity to update. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryption'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateFieldLevelEncryptionConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateFieldLevelEncryptionConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet"> <summary> Update a field-level encryption profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_CallerReference"> <summary> <para> <para>A unique number that ensures that the request can't be replayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_Comment"> <summary> <para> <para>An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.Id"> <summary> <para> <para>The ID of the field-level encryption profile request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the profile identity to update. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.EncryptionEntities_Item"> <summary> <para> <para>An array of field patterns in a field-level encryption content type-profile mapping. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.FieldLevelEncryptionProfileConfig_Name"> <summary> <para> <para>Profile name for the field-level encryption profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.EncryptionEntities_Quantity"> <summary> <para> <para>Number of field pattern items in a field-level encryption content type-profile mapping.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FieldLevelEncryptionProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateFieldLevelEncryptionProfileResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateFieldLevelEncryptionProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFieldLevelEncryptionProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet"> <summary> Updates a CloudFront function. <para> You can update a function's code or the comment that describes the function. You cannot update a function's name. </para><para> To update a function, you provide the function's name and version (<c>ETag</c> value) along with the updated function code. To get the name and version, you can use <c>ListFunctions</c> and <c>DescribeFunction</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.FunctionConfig_Comment"> <summary> <para> <para>A comment to describe the function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.FunctionCode"> <summary> <para> <para>The function code. For more information about writing a CloudFront function, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html">Writing function code for CloudFront Functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the function that you are updating, which you can get using <c>DescribeFunction</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.KeyValueStoreAssociations_Item"> <summary> <para> <para>The items of the key value store association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.Name"> <summary> <para> <para>The name of the function that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.KeyValueStoreAssociations_Quantity"> <summary> <para> <para>The quantity of key value store associations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.FunctionConfig_Runtime"> <summary> <para> <para>The function's runtime environment version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FunctionSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateFunctionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateFunctionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFFunctionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet"> <summary> Updates a key group. <para> When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group: </para><ol><li><para> Get the current key group with <c>GetKeyGroup</c> or <c>GetKeyGroupConfig</c>. </para></li><li><para> Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs. </para></li><li><para> Call <c>UpdateKeyGroup</c> with the entire key group object, including the fields that you modified and those that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.KeyGroupConfig_Comment"> <summary> <para> <para>A comment to describe the key group. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.Id"> <summary> <para> <para>The identifier of the key group that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.IfMatch"> <summary> <para> <para>The version of the key group that you are updating. The version is the key group's <c>ETag</c> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.KeyGroupConfig_Item"> <summary> <para> <para>A list of the identifiers of the public keys in the key group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.KeyGroupConfig_Name"> <summary> <para> <para>A name to identify the key group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateKeyGroupResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateKeyGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet"> <summary> Specifies the key value store to update. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.Comment"> <summary> <para> <para>The comment of the key value store to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.IfMatch"> <summary> <para> <para>The key value store to update, if a match occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.Name"> <summary> <para> <para>The name of the key value store to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyValueStore'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateKeyValueStoreResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateKeyValueStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFKeyValueStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet"> <summary> Updates a CloudFront origin access control. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.OriginAccessControlConfig_Description"> <summary> <para> <para>A description of the origin access control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.Id"> <summary> <para> <para>The unique identifier of the origin access control that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.IfMatch"> <summary> <para> <para>The current version (<c>ETag</c> value) of the origin access control that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.OriginAccessControlConfig_Name"> <summary> <para> <para>A name to identify the origin access control. You can specify up to 64 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.OriginAccessControlConfig_OriginAccessControlOriginType"> <summary> <para> <para>The type of origin that this origin access control is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.OriginAccessControlConfig_SigningBehavior"> <summary> <para> <para>Specifies which requests CloudFront signs (adds authentication information to). Specify <c>always</c> for the most common use case. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings">origin access control advanced settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</para><para>This field can have one of the following values:</para><ul><li><para><c>always</c> – CloudFront signs all origin requests, overwriting the <c>Authorization</c> header from the viewer request if one exists.</para></li><li><para><c>never</c> – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.</para></li><li><para><c>no-override</c> – If the viewer request doesn't contain the <c>Authorization</c> header, then CloudFront signs the origin request. If the viewer request contains the <c>Authorization</c> header, then CloudFront doesn't sign the origin request and instead passes along the <c>Authorization</c> header from the viewer request. <b>WARNING: To pass along the <c>Authorization</c> header from the viewer request, you <i>must</i> add the <c>Authorization</c> header to a <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html">cache policy</a> for all cache behaviors that use origins associated with this origin access control.</b></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.OriginAccessControlConfig_SigningProtocol"> <summary> <para> <para>The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is <c>sigv4</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginAccessControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateOriginAccessControlResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateOriginAccessControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginAccessControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet"> <summary> Updates an origin request policy configuration. <para> When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration: </para><ol><li><para> Use <c>GetOriginRequestPolicyConfig</c> to get the current configuration. </para></li><li><para> Locally modify the fields in the origin request policy configuration that you want to update. </para></li><li><para> Call <c>UpdateOriginRequestPolicy</c> by providing the entire origin request policy configuration, including the fields that you modified and those that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.OriginRequestPolicyConfig_Comment"> <summary> <para> <para>A comment to describe the origin request policy. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.CookiesConfig_CookieBehavior"> <summary> <para> <para>Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any cookies that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the cookies in viewer requests that are listed in the <c>CookieNames</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>all</c> – All cookies in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All cookies in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>CookieNames</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.HeadersConfig_HeaderBehavior"> <summary> <para> <para>Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any headers that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the HTTP headers that are listed in the <c>Headers</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allViewer</c> – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allViewerAndWhitelistCloudFront</c> – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the <c>Headers</c> type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.</para></li><li><para><c>allExcept</c> – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>Headers</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Id"> <summary> <para> <para>The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior's <c>OriginRequestPolicyId</c> field in the response to <c>GetDistributionConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the origin request policy that you are updating. The version is returned in the origin request policy's <c>ETag</c> field in the response to <c>GetOriginRequestPolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Cookies_Item"> <summary> <para> <para>A list of cookie names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Headers_Item"> <summary> <para> <para>A list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.QueryStrings_Item"> <summary> <para> <para>A list of query string names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.OriginRequestPolicyConfig_Name"> <summary> <para> <para>A unique name to identify the origin request policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Cookies_Quantity"> <summary> <para> <para>The number of cookie names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Headers_Quantity"> <summary> <para> <para>The number of header names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.QueryStrings_Quantity"> <summary> <para> <para>The number of query string names in the <c>Items</c> list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.QueryStringsConfig_QueryStringBehavior"> <summary> <para> <para>Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:</para><ul><li><para><c>none</c> – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to <c>none</c>, any query strings that are listed in a <c>CachePolicy</c><i>are</i> included in origin requests.</para></li><li><para><c>whitelist</c> – Only the query strings in viewer requests that are listed in the <c>QueryStringNames</c> type are included in requests that CloudFront sends to the origin.</para></li><li><para><c>all</c> – All query strings in viewer requests are included in requests that CloudFront sends to the origin.</para></li><li><para><c>allExcept</c> – All query strings in viewer requests are included in requests that CloudFront sends to the origin, <i><b>except</b></i> for those listed in the <c>QueryStringNames</c> type, which are not included.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OriginRequestPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateOriginRequestPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateOriginRequestPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFOriginRequestPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet"> <summary> Update public key information. Note that the only value you can change is the comment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_CallerReference"> <summary> <para> <para>A string included in the request to help make sure that the request can't be replayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_Comment"> <summary> <para> <para>A comment to describe the public key. The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_EncodedKey"> <summary> <para> <para>The public key that you can use with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html">signed URLs and signed cookies</a>, or with <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html">field-level encryption</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.Id"> <summary> <para> <para>The identifier of the public key that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the public key to update. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_Name"> <summary> <para> <para>A name to help identify the public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdatePublicKeyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdatePublicKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet"> <summary> Updates a real-time log configuration. <para> When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration: </para><ol><li><para> Call <c>GetRealtimeLogConfig</c> to get the current real-time log configuration. </para></li><li><para> Locally modify the parameters in the real-time log configuration that you want to update. </para></li><li><para> Call this API (<c>UpdateRealtimeLogConfig</c>) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't. </para></li></ol><para> You cannot update a real-time log configuration's <c>Name</c> or <c>ARN</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.ARN"> <summary> <para> <para>The Amazon Resource Name (ARN) for this real-time log configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.EndPoint"> <summary> <para> <para>Contains information about the Amazon Kinesis data stream where you are sending real-time log data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.Field"> <summary> <para> <para>A list of fields to include in each real-time log record.</para><para>For more information about fields, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields">Real-time log configuration fields</a> in the <i>Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.Name"> <summary> <para> <para>The name for this real-time log configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.SamplingRate"> <summary> <para> <para>The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RealtimeLogConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateRealtimeLogConfigResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateRealtimeLogConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFRealtimeLogConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet"> <summary> Updates a response headers policy. <para> When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration: </para><ol><li><para> Use <c>GetResponseHeadersPolicyConfig</c> to get the current policy's configuration. </para></li><li><para> Modify the fields in the response headers policy configuration that you want to update. </para></li><li><para> Call <c>UpdateResponseHeadersPolicy</c>, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.CorsConfig_AccessControlAllowCredential"> <summary> <para> <para>A Boolean that CloudFront uses as the value for the <c>Access-Control-Allow-Credentials</c> HTTP response header.</para><para>For more information about the <c>Access-Control-Allow-Credentials</c> HTTP response header, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials">Access-Control-Allow-Credentials</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.CorsConfig_AccessControlMaxAgeSec"> <summary> <para> <para>A number that CloudFront uses as the value for the <c>Access-Control-Max-Age</c> HTTP response header.</para><para>For more information about the <c>Access-Control-Max-Age</c> HTTP response header, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age">Access-Control-Max-Age</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_AccessControlMaxAgeSec"> <summary> <para> <para>A number that CloudFront uses as the value for the <c>max-age</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ResponseHeadersPolicyConfig_Comment"> <summary> <para> <para>A comment to describe the response headers policy.</para><para>The comment cannot be longer than 128 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ContentSecurityPolicy_ContentSecurityPolicy"> <summary> <para> <para>The policy directives and their values that CloudFront includes as values for the <c>Content-Security-Policy</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ServerTimingHeadersConfig_Enabled"> <summary> <para> <para>A Boolean that determines whether CloudFront adds the <c>Server-Timing</c> header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.FrameOptions_FrameOption"> <summary> <para> <para>The value of the <c>X-Frame-Options</c> HTTP response header. Valid values are <c>DENY</c> and <c>SAMEORIGIN</c>.</para><para>For more information about these values, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options">X-Frame-Options</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.Id"> <summary> <para> <para>The identifier for the response headers policy that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.IfMatch"> <summary> <para> <para>The version of the response headers policy that you are updating.</para><para>The version is returned in the cache policy's <c>ETag</c> field in the response to <c>GetResponseHeadersPolicyConfig</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_IncludeSubdomain"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>includeSubDomains</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowHeaders_Item"> <summary> <para> <para>The list of HTTP header names. You can specify <c>*</c> to allow all headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowMethods_Item"> <summary> <para> <para>The list of HTTP methods. Valid values are:</para><ul><li><para><c>GET</c></para></li><li><para><c>DELETE</c></para></li><li><para><c>HEAD</c></para></li><li><para><c>OPTIONS</c></para></li><li><para><c>PATCH</c></para></li><li><para><c>POST</c></para></li><li><para><c>PUT</c></para></li><li><para><c>ALL</c></para></li></ul><para><c>ALL</c> is a special value that includes all of the listed HTTP methods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowOrigins_Item"> <summary> <para> <para>The list of origins (domain names). You can specify <c>*</c> to allow all origins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlExposeHeaders_Item"> <summary> <para> <para>The list of HTTP headers. You can specify <c>*</c> to expose all headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.CustomHeadersConfig_Item"> <summary> <para> <para>The list of HTTP response headers and their values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.RemoveHeadersConfig_Item"> <summary> <para> <para>The list of HTTP header names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.XSSProtection_ModeBlock"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>mode=block</c> directive in the <c>X-XSS-Protection</c> header.</para><para>For more information about this directive, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ResponseHeadersPolicyConfig_Name"> <summary> <para> <para>A name to identify the response headers policy.</para><para>The name must be unique for response headers policies in this Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.CorsConfig_OriginOverride"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ContentSecurityPolicy_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Content-Security-Policy</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ContentTypeOptions_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-Content-Type-Options</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.FrameOptions_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-Frame-Options</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ReferrerPolicy_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Referrer-Policy</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>Strict-Transport-Security</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.XSSProtection_Override"> <summary> <para> <para>A Boolean that determines whether CloudFront overrides the <c>X-XSS-Protection</c> HTTP response header received from the origin with the one specified in this response headers policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.StrictTransportSecurity_Preload"> <summary> <para> <para>A Boolean that determines whether CloudFront includes the <c>preload</c> directive in the <c>Strict-Transport-Security</c> HTTP response header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.XSSProtection_Protection"> <summary> <para> <para>A Boolean that determines the value of the <c>X-XSS-Protection</c> HTTP response header. When this setting is <c>true</c>, the value of the <c>X-XSS-Protection</c> header is <c>1</c>. When this setting is <c>false</c>, the value of the <c>X-XSS-Protection</c> header is <c>0</c>.</para><para>For more information about these settings, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowHeaders_Quantity"> <summary> <para> <para>The number of HTTP header names in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowMethods_Quantity"> <summary> <para> <para>The number of HTTP methods in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlAllowOrigins_Quantity"> <summary> <para> <para>The number of origins in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.AccessControlExposeHeaders_Quantity"> <summary> <para> <para>The number of HTTP headers in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.CustomHeadersConfig_Quantity"> <summary> <para> <para>The number of HTTP response headers in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.RemoveHeadersConfig_Quantity"> <summary> <para> <para>The number of HTTP header names in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ReferrerPolicy_ReferrerPolicy"> <summary> <para> <para>The value of the <c>Referrer-Policy</c> HTTP response header. Valid values are:</para><ul><li><para><c>no-referrer</c></para></li><li><para><c>no-referrer-when-downgrade</c></para></li><li><para><c>origin</c></para></li><li><para><c>origin-when-cross-origin</c></para></li><li><para><c>same-origin</c></para></li><li><para><c>strict-origin</c></para></li><li><para><c>strict-origin-when-cross-origin</c></para></li><li><para><c>unsafe-url</c></para></li></ul><para>For more information about these values, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy">Referrer-Policy</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.XSSProtection_ReportUri"> <summary> <para> <para>A reporting URI, which CloudFront uses as the value of the <c>report</c> directive in the <c>X-XSS-Protection</c> header.</para><para>You cannot specify a <c>ReportUri</c> when <c>ModeBlock</c> is <c>true</c>.</para><para>For more information about using a reporting URL, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection">X-XSS-Protection</a> in the MDN Web Docs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.ServerTimingHeadersConfig_SamplingRate"> <summary> <para> <para>A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the <c>Server-Timing</c> header to. When you set the sampling rate to 100, CloudFront adds the <c>Server-Timing</c> header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseHeadersPolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateResponseHeadersPolicyResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateResponseHeadersPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFResponseHeadersPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet"> <summary> Update a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Bucket"> <summary> <para> <para>The Amazon S3 bucket to store the access logs in, for example, <c>myawslogbucket.s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_CallerReference"> <summary> <para> <para>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</para><para>If the value of <c>CallerReference</c> is new (regardless of the content of the <c>StreamingDistributionConfig</c> object), CloudFront creates a new distribution.</para><para>If <c>CallerReference</c> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <c>DistributionAlreadyExists</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.S3Origin_DomainName"> <summary> <para> <para>The DNS name of the Amazon S3 origin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_Enabled"> <summary> <para> <para>Whether the streaming distribution is enabled to accept user requests for content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Enabled"> <summary> <para> <para>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <c>false</c> for <c>Enabled</c>, and specify <c>empty Bucket</c> and <c>Prefix</c> elements. If you specify <c>false</c> for <c>Enabled</c> but you specify values for <c>Bucket</c> and <c>Prefix</c>, the values are automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>This field is <c>true</c> if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Id"> <summary> <para> <para>The streaming distribution's id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.IfMatch"> <summary> <para> <para>The value of the <c>ETag</c> header that you received when retrieving the streaming distribution's configuration. For example: <c>E2QWRUHAPOMQZL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Aliases_Item"> <summary> <para> <para>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para>A list of Amazon Web Services account identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.S3Origin_OriginAccessIdentity"> <summary> <para> <para>The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</para><para>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <c>OriginAccessIdentity</c> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <c>OriginAccessIdentity</c> element.</para><para>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i> Amazon CloudFront Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Prefix"> <summary> <para> <para>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <c>myprefix/</c>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <c>Prefix</c> element in the <c>Logging</c> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_PriceClass"> <summary> <para> <para>A complex type that contains information about price class for this streaming distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Aliases_Quantity"> <summary> <para> <para>The number of CNAME aliases, if any, that you want to associate with this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of Amazon Web Services accounts in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingDistribution'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateStreamingDistributionResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateStreamingDistributionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |