AWS Tools for Windows PowerShell
Command Reference

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

Synopsis

Calls the Amazon CloudFront UpdateDistributionTenant API operation.

Syntax

Update-CFDistributionTenant
-Id <String>
-WebAcl_Action <CustomizationActionType>
-Certificate_Arn <String>
-WebAcl_Arn <String>
-ManagedCertificateRequest_CertificateTransparencyLoggingPreference <CertificateTransparencyLoggingPreference>
-ConnectionGroupId <String>
-DistributionId <String>
-Domain <DomainItem[]>
-Enabled <Boolean>
-IfMatch <String>
-GeoRestrictions_Location <String[]>
-Parameter <Parameter[]>
-ManagedCertificateRequest_PrimaryDomainName <String>
-GeoRestrictions_RestrictionType <GeoRestrictionType>
-ManagedCertificateRequest_ValidationTokenHost <ValidationTokenHost>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudFrontConfig>

Description

Updates a distribution tenant.

Parameters

-Certificate_Arn <String>
The Amazon Resource Name (ARN) of the ACM certificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizations_Certificate_Arn
-ClientConfig <AmazonCloudFrontConfig>
Amazon.PowerShell.Cmdlets.CF.AmazonCloudFrontClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionGroupId <String>
The ID of the target connection group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DistributionId <String>
The ID for the multi-tenant distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <DomainItem[]>
The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomains
-Enabled <Boolean>
Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GeoRestrictions_Location <String[]>
The locations for geographic restrictions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizations_GeoRestrictions_Locations
-GeoRestrictions_RestrictionType <GeoRestrictionType>
The method that you want to use to restrict distribution of your content by country:
  • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizations_GeoRestrictions_RestrictionType
-Id <String>
The ID of the distribution tenant.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-IfMatch <String>
The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedCertificateRequest_CertificateTransparencyLoggingPreference <CertificateTransparencyLoggingPreference>
You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedCertificateRequest_PrimaryDomainName <String>
The primary domain name associated with the CloudFront managed ACM certificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedCertificateRequest_ValidationTokenHost <ValidationTokenHost>
Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
  • For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
  • For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Parameter <Parameter[]>
A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DistributionTenant'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.UpdateDistributionTenantResponse). Specifying the name of a property of type Amazon.CloudFront.Model.UpdateDistributionTenantResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WebAcl_Action <CustomizationActionType>
The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizations_WebAcl_Action
-WebAcl_Arn <String>
The Amazon Resource Name (ARN) of the WAF web ACL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizations_WebAcl_Arn

Common Credential and Region Parameters

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

Outputs

Amazon.CloudFront.Model.DistributionTenant or Amazon.CloudFront.Model.UpdateDistributionTenantResponse
This cmdlet returns an Amazon.CloudFront.Model.DistributionTenant object. The service call response (type Amazon.CloudFront.Model.UpdateDistributionTenantResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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