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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.AddCFResourceTagCmdlet.Tag"> <summary> <para> <para> A complex type that contains <code>Tag</code> 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.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 <code>Marker</code> to the value of the <code>NextMarker</code> 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.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 <code>Marker</code> to the value of the <code>NextMarker</code> 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 AWS 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 AWS 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.Marker"> <summary> <para> <para>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </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.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 <code>Marker</code> to the value of the <code>NextMarker</code> 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 <code>Marker</code> to the value of the <code>NextMarker</code> 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.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, <code>IDFDVBD632BHDS5</code>.</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 <code>Marker</code> to the value of the <code>NextMarker</code> 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.GetCFPublicKeyCmdlet"> <summary> Get the public key information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyCmdlet.Id"> <summary> <para> <para>Request the ID for the public key.</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> Return public key configuration informaation </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFPublicKeyConfigCmdlet.Id"> <summary> <para> <para>Request the ID for the public key configuration.</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 <code>Marker</code> to the value of the <code>NextMarker</code> 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.GetCFResourceTagCmdlet"> <summary> List tags for a CloudFront resource. </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.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 <code>Marker</code> 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 <code>MaxItems</code> 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.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 <code>CallerReference</code> is new (regardless of the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</para><para>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </para><para>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> <para>Any comments you want to include about the origin access identity. </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.NewCFDistributionCmdlet"> <summary> Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource. <important><para> When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-overview-required-fields.html">Required Fields for Create Distribution and Update Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS 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 (<code>us-east-1</code>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>d111111abcdef8.cloudfront.net</code>, set this field to <code>true</code>.</para><para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set this field to <code>false</code> and specify values for the following fields:</para><ul><li><para><code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a value for one, not both)</para></li><li><para><code>MinimumProtocolVersion</code></para></li><li><para><code>SSLSupportMethod</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the distribution.</para><para>If you don't want to specify a comment, include an empty <code>Comment</code> element.</para><para>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</para><para>To add or change a comment, update the distribution configuration and specify the new comment.</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 <code>true</code>; if not, specify <code>false</code>. 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_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> 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 <code>DefaultRootObject</code> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> 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.DefaultCacheBehavior_DefaultTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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 <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, 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 <code>ID</code> 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>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> 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 <code>Forward</code> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. 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 TLS 1.2 or later, and must support Server Name Identification (SNI).</para><para>In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS Identity and Access Management (AWS IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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 <code>true</code> for <code>IncludeCookies</code>. 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 <code>false</code> for <code>IncludeCookies</code>.</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 <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> 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 <code>IpAddress</code> 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 Amazon Route 53 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>Amazon Route 53 Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Amazon Route 53 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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <code>CustomErrorResponse</code> 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.</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 complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the <code>Quantity</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this field must contain at least one item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Item"> <summary> <para> <para>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</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 <code>Quantity</code> is 0, you can omit <code>Items</code>. </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 <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 complex type that contains origins or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> <para> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</para><para>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</para><para>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> 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.DefaultCacheBehavior_MaxTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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>We recommend that you specify <code>TLSv1.2_2018</code> unless your viewers are using browsers or devices that don’t support TLSv1.2.</para><para>When you’re using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </para><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <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 <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</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 <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <code>PriceClass_All</code>, 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>. For price class information, scroll down to see the table at the bottom of the page.</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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> 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 <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the <code>Items</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this value must be <code>1</code> or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Quantity"> <summary> <para> <para>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</para><ul><li><para><b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</para><important><para>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </para></important></li><li><para><b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</para></li><li><para><b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</para></li></ul><para>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</para><ul><li><para><b>S3 bucket</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers">HTTP Request Headers That CloudFront Removes or Updates</a></para></li><li><para><b>Custom origin</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior">HTTP Request Headers and CloudFront Behavior</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <code>whitelisted</code> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of trusted signers for this cache behavior.</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 or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <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 <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</para><para>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code>, 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.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><code>whitelist</code>: The <code>Location</code> 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 <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><code>sni-only</code> – 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 released after 2010 support SNI.</para></li><li><para><code>vip</code> – 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></ul><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don’t set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <code>ID</code> 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 <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</para><ul><li><para><code>allow-all</code>: Viewers can use HTTP or HTTPS.</para></li><li><para><code>redirect-to-https</code>: 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><code>https-only</code>: 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 AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</para><para>AWS 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 AWS WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">AWS 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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></para></li></ul> </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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS 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 (<code>us-east-1</code>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>d111111abcdef8.cloudfront.net</code>, set this field to <code>true</code>.</para><para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set this field to <code>false</code> and specify values for the following fields:</para><ul><li><para><code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a value for one, not both)</para></li><li><para><code>MinimumProtocolVersion</code></para></li><li><para><code>SSLSupportMethod</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the distribution.</para><para>If you don't want to specify a comment, include an empty <code>Comment</code> element.</para><para>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</para><para>To add or change a comment, update the distribution configuration and specify the new comment.</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 <code>true</code>; if not, specify <code>false</code>. 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_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> 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 <code>DefaultRootObject</code> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> 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.DefaultCacheBehavior_DefaultTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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 <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, 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 <code>ID</code> 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>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> 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 <code>Forward</code> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. 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 TLS 1.2 or later, and must support Server Name Identification (SNI).</para><para>In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS Identity and Access Management (AWS IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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 <code>true</code> for <code>IncludeCookies</code>. 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 <code>false</code> for <code>IncludeCookies</code>.</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 <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> 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 <code>IpAddress</code> 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 Amazon Route 53 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>Amazon Route 53 Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Amazon Route 53 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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <code>CustomErrorResponse</code> 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.</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 complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the <code>Quantity</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this field must contain at least one item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Headers_Item"> <summary> <para> <para>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</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 <code>Quantity</code> is 0, you can omit <code>Items</code>. </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 <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 complex type that contains origins or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.GeoRestriction_Item"> <summary> <para> <para> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</para><para>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</para><para>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> 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 <code>Tag</code> elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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>We recommend that you specify <code>TLSv1.2_2018</code> unless your viewers are using browsers or devices that don’t support TLSv1.2.</para><para>When you’re using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </para><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <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 <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</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 <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <code>PriceClass_All</code>, 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>. For price class information, scroll down to see the table at the bottom of the page.</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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> 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 <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the <code>Items</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this value must be <code>1</code> or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.Headers_Quantity"> <summary> <para> <para>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</para><ul><li><para><b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</para><important><para>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </para></important></li><li><para><b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</para></li><li><para><b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</para></li></ul><para>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</para><ul><li><para><b>S3 bucket</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers">HTTP Request Headers That CloudFront Removes or Updates</a></para></li><li><para><b>Custom origin</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior">HTTP Request Headers and CloudFront Behavior</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <code>whitelisted</code> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of trusted signers for this cache behavior.</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 or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ForwardedValues_QueryString"> <summary> <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 <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</para><para>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code>, 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.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><code>whitelist</code>: The <code>Location</code> 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 <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><code>sni-only</code> – 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 released after 2010 support SNI.</para></li><li><para><code>vip</code> – 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></ul><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don’t set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionWithTagCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <code>ID</code> 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 <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</para><ul><li><para><code>allow-all</code>: Viewers can use HTTP or HTTPS.</para></li><li><para><code>redirect-to-https</code>: 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><code>https-only</code>: 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 AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</para><para>AWS 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 AWS WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">AWS 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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></para></li></ul> </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.</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.NewCFInvalidationCmdlet"> <summary> Create a new invalidation. </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 <code>CallerReference</code> and change other values in the request as applicable. One way to ensure that the value of <code>CallerReference</code> is unique is to use a <code>timestamp</code>, for example, <code>20120301090000</code>.</para><para>If you make a second invalidation request with the same value for <code>CallerReference</code>, 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 <code>CallerReference</code>.</para><para>If <code>CallerReference</code> is a value you already sent in a previous invalidation batch request but the content of any <code>Path</code> is different from the original request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> 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.NewCFPublicKeyCmdlet"> <summary> Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_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.NewCFPublicKeyCmdlet.PublicKeyConfig_Comment"> <summary> <para> <para>An optional comment about a public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_EncodedKey"> <summary> <para> <para>The encoded public key that you want to add to CloudFront to use with features like field-level encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFPublicKeyCmdlet.PublicKeyConfig_Name"> <summary> <para> <para>The name for a public key you add to CloudFront to use with features like field-level encryption.</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.NewCFStreamingDistributionCmdlet"> <summary> Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. <para> To create a new distribution, submit a <code>POST</code> request to the <i>CloudFront API version</i>/distribution resource. The request body must include a document with a <i>StreamingDistributionConfig</i> element. The response echoes the <code>StreamingDistributionConfig</code> element and returns other information about the RTMP distribution. </para><para> To get the status of your request, use the <i>GET StreamingDistribution</i> API action. When the value of <code>Enabled</code> is <code>true</code> and the value of <code>Status</code> is <code>Deployed</code>, your distribution is ready. A distribution usually deploys in less than 15 minutes. </para><para> For more information about web distributions, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-rtmp.html">Working with RTMP Distributions</a> in the <i>Amazon CloudFront Developer Guide</i>. </para><important><para> Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values specified. </para></important> </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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>StreamingDistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 <code>OriginAccessIdentity</code> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> 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, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 trusted signers for this cache behavior.</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> Create a new streaming distribution with tags. </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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>StreamingDistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionWithTagCmdlet.Tags_Item"> <summary> <para> <para> A complex type that contains <code>Tag</code> 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 <code>OriginAccessIdentity</code> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> 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, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 trusted signers for this cache behavior.</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.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 <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</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.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 <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </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 <code>ETag</code> header that you received when retrieving the configuration identity to delete. For example: <code>E2QWRUHAPOMQZL</code>.</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 <code>ETag</code> header that you received when retrieving the profile to delete. For example: <code>E2QWRUHAPOMQZL</code>.</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.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 <code>ETag</code> header that you received when retrieving the public key identity to delete. For example: <code>E2QWRUHAPOMQZL</code>.</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.RemoveCFResourceTagCmdlet"> <summary> Remove tags from a CloudFront resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFResourceTagCmdlet.TagKey"> <summary> <para> <para> A complex type that contains <code>Tag</code> 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.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 <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </para></li><li><para> Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>. </para></li><li><para> Submit a <code>PUT Streaming Distribution Config</code> 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 <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2. </para></li><li><para> Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled. </para></li><li><para> Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>. </para></li><li><para> Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2. </para></li><li><para> Review the response to your <code>DELETE Streaming Distribution</code> 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 <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</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.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 <code>CallerReference</code> is new (regardless of the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</para><para>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </para><para>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> <para>Any comments you want to include about the origin access identity. </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 <code>ETag</code> header that you received when retrieving the identity's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</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.UpdateCFDistributionCmdlet"> <summary> Updates the configuration for a web distribution. <important><para> When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-overview-required-fields.html">Required Fields for Create Distribution and Update Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para></important><para> The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an <code>UpdateDistribution</code> request to make the updates. </para><para> For information about updating a distribution using the CloudFront console instead, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html">Creating a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </para><para><b>To update a web distribution using the CloudFront API</b></para><ol><li><para> Submit a <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html">GetDistributionConfig</a> request to get the current configuration and an <code>Etag</code> header for the distribution. </para><note><para> If you update the distribution again, you must get a new <code>Etag</code> header. </para></note></li><li><para> Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include your changes. </para><important><para> When you edit the XML file, be aware of the following: </para><ul><li><para> You must strip out the ETag parameter that is returned. </para></li><li><para> Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution. </para></li><li><para> You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an <code>IllegalUpdate</code> error. </para></li><li><para> The new configuration replaces the existing configuration; the values that you specify in an <code>UpdateDistribution</code> request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, <code>CNAME</code>), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding <code>Quantity</code> element. </para></li></ul></important></li><li><para> Submit an <code>UpdateDistribution</code> request to update the configuration for your distribution: </para><ul><li><para> In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a <code>DistributionConfig</code> element. </para></li><li><para> Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GetDistributionConfig</code> request in Step 1. </para></li></ul></li><li><para> Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was successfully updated. </para></li><li><para> Optional: Submit a <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html">GetDistribution</a> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_ACMCertificateArn"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS 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 (<code>us-east-1</code>).</para><para>If you specify an ACM certificate ARN, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>d111111abcdef8.cloudfront.net</code>, set this field to <code>true</code>.</para><para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set this field to <code>false</code> and specify values for the following fields:</para><ul><li><para><code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a value for one, not both)</para></li><li><para><code>MinimumProtocolVersion</code></para></li><li><para><code>SSLSupportMethod</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> <para>Any comments you want to include about the distribution.</para><para>If you don't want to specify a comment, include an empty <code>Comment</code> element.</para><para>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</para><para>To add or change a comment, update the distribution configuration and specify the new comment.</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 <code>true</code>; if not, specify <code>false</code>. 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_DefaultRootObject"> <summary> <para> <para>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</para><para>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> 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 <code>DefaultRootObject</code> element.</para><para>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> 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.DefaultCacheBehavior_DefaultTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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 <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, 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 <code>ID</code> 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>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> 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 <code>Forward</code> element.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_HttpVersion"> <summary> <para> <para>(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. 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 TLS 1.2 or later, and must support Server Name Identification (SNI).</para><para>In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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">AWS Identity and Access Management (AWS IAM)</a>, provide the ID of the IAM certificate.</para><para>If you specify an IAM certificate ID, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </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 <code>ETag</code> header that you received when retrieving the distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</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 <code>true</code> for <code>IncludeCookies</code>. 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 <code>false</code> for <code>IncludeCookies</code>.</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 <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> 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 <code>IpAddress</code> 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 Amazon Route 53 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>Amazon Route 53 Developer Guide</i>.</para><para>If you created a CNAME resource record set, either with Amazon Route 53 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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> <para>A complex type that contains a <code>CustomErrorResponse</code> 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.</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 complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the <code>Quantity</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this field must contain at least one item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Item"> <summary> <para> <para>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</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 <code>Quantity</code> is 0, you can omit <code>Items</code>. </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 <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> <para><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 complex type that contains origins or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> <para> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</para><para>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</para><para>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> 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.DefaultCacheBehavior_MaxTTL"> <summary> <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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (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>We recommend that you specify <code>TLSv1.2_2018</code> unless your viewers are using browsers or devices that don’t support TLSv1.2.</para><para>When you’re using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </para><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <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 <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</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 <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</para><para>If you specify a price class other than <code>PriceClass_All</code>, 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>. For price class information, scroll down to see the table at the bottom of the page.</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 <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> 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 <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> <para>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the <code>Items</code> field.</para><para>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this value must be <code>1</code> or higher.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Quantity"> <summary> <para> <para>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</para><ul><li><para><b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</para><important><para>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </para></important></li><li><para><b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</para></li><li><para><b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</para></li></ul><para>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</para><ul><li><para><b>S3 bucket</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers">HTTP Request Headers That CloudFront Removes or Updates</a></para></li><li><para><b>Custom origin</b>: See <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior">HTTP Request Headers and CloudFront Behavior</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.QueryStringCacheKeys_Quantity"> <summary> <para> <para>The number of <code>whitelisted</code> query string parameters for a cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.LambdaFunctionAssociations_Quantity"> <summary> <para> <para>The number of Lambda function associations for this cache behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> <para>The number of trusted signers for this cache behavior.</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 or origin groups for this distribution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> <para>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <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 <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</para><para>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, 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 <code>QueryString</code>, 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.GeoRestriction_RestrictionType"> <summary> <para> <para>The method that you want to use to restrict distribution of your content by country:</para><ul><li><para><code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</para></li><li><para><code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</para></li><li><para><code>whitelist</code>: The <code>Location</code> 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 <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> <para>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</para><ul><li><para><code>sni-only</code> – 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 released after 2010 support SNI.</para></li><li><para><code>vip</code> – 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></ul><para>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don’t set a value for this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> <para>The value of <code>ID</code> 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 <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</para><ul><li><para><code>allow-all</code>: Viewers can use HTTP or HTTPS.</para></li><li><para><code>redirect-to-https</code>: 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><code>https-only</code>: 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 AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</para><para>AWS 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 AWS WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">AWS 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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></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><code>ACMCertificateArn</code></para></li><li><para><code>IAMCertificateId</code></para></li><li><para><code>CloudFrontDefaultCertificate</code></para></li></ul> </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.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 <code>ETag</code> header that you received when retrieving the configuration identity to update. For example: <code>E2QWRUHAPOMQZL</code>.</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.</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 <code>ETag</code> header that you received when retrieving the profile identity to update. For example: <code>E2QWRUHAPOMQZL</code>.</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.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 unique number that ensures that the request can't be replayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_Comment"> <summary> <para> <para>An optional comment about a public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_EncodedKey"> <summary> <para> <para>The encoded public key that you want to add to CloudFront to use with features like field-level encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.Id"> <summary> <para> <para>ID of the public key to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.IfMatch"> <summary> <para> <para>The value of the <code>ETag</code> header that you received when retrieving the public key to update. For example: <code>E2QWRUHAPOMQZL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFPublicKeyCmdlet.PublicKeyConfig_Name"> <summary> <para> <para>The name for a public key you add to CloudFront to use with features like field-level encryption.</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.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, <code>myawslogbucket.s3.amazonaws.com</code>.</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 <code>CallerReference</code> is new (regardless of the content of the <code>StreamingDistributionConfig</code> object), CloudFront creates a new distribution.</para><para>If <code>CallerReference</code> is a value that you already sent in a previous request to create a distribution, CloudFront returns a <code>DistributionAlreadyExists</code> 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 <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> <para>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</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 <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</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><b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</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 <code>OriginAccessIdentity</code> element.</para><para>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> 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, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> 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 trusted signers for this cache behavior.</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> |