Synopsis
Calls the Amazon Simple Storage Service PutBucketWebsite API operation.
Syntax
Write-S3BucketWebsite-BucketName <String>-WebsiteConfiguration_ErrorDocument <String>-RedirectAllRequestsTo_HostName <String>-RedirectAllRequestsTo_HttpRedirectCode <String>-WebsiteConfiguration_IndexDocumentSuffix <String>-RedirectAllRequestsTo_Protocol <String>-RedirectAllRequestsTo_ReplaceKeyPrefixWith <String>-RedirectAllRequestsTo_ReplaceKeyWith <String>-WebsiteConfiguration_RoutingRule <RoutingRule[]>-UseAccelerateEndpoint <SwitchParameter>-UseDualstackEndpoint <SwitchParameter>-PassThru <SwitchParameter>-Force <SwitchParameter>
Description
Set the website configuration for a bucket.
Parameters
-BucketName <String>
The name of the bucket to apply the configuration to.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, 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? | False |
-PassThru <SwitchParameter>
Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RedirectAllRequestsTo_HostName <String>
Name of the host where requests will be redirected.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RedirectAllRequestsTo_HostName |
-RedirectAllRequestsTo_HttpRedirectCode <String>
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RedirectAllRequestsTo_HttpRedirectCode |
-RedirectAllRequestsTo_Protocol <String>
Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RedirectAllRequestsTo_Protocol |
-RedirectAllRequestsTo_ReplaceKeyPrefixWith <String>
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RedirectAllRequestsTo_ReplaceKeyPrefixWith |
-RedirectAllRequestsTo_ReplaceKeyWith <String>
The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RedirectAllRequestsTo_ReplaceKeyWith |
-UseAccelerateEndpoint <SwitchParameter>
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UseDualstackEndpoint <SwitchParameter>
Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-WebsiteConfiguration_ErrorDocument <String>
The ErrorDocument value, an object key name to use when a 4XX class error occurs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-WebsiteConfiguration_IndexDocumentSuffix <String>
This value is a suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html)The suffix must not be empty and must not include a slash character.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-WebsiteConfiguration_RoutingRule <RoutingRule[]>
The list of routing rules that can be used for configuring redirects if certain conditions are meet.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | WebsiteConfiguration_RoutingRules |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the BucketName parameter.
Outputs
None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketWebsiteResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
