Class CfnBucket.WebsiteConfigurationProperty
Specifies website configuration parameters for an Amazon S3 bucket.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebsiteConfigurationProperty : Object, CfnBucket.IWebsiteConfigurationProperty
Syntax (vb)
Public Class WebsiteConfigurationProperty
Inherits Object
Implements CfnBucket.IWebsiteConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;
var websiteConfigurationProperty = new WebsiteConfigurationProperty {
ErrorDocument = "errorDocument",
IndexDocument = "indexDocument",
RedirectAllRequestsTo = new RedirectAllRequestsToProperty {
HostName = "hostName",
// the properties below are optional
Protocol = "protocol"
},
RoutingRules = new [] { new RoutingRuleProperty {
RedirectRule = new RedirectRuleProperty {
HostName = "hostName",
HttpRedirectCode = "httpRedirectCode",
Protocol = "protocol",
ReplaceKeyPrefixWith = "replaceKeyPrefixWith",
ReplaceKeyWith = "replaceKeyWith"
},
// the properties below are optional
RoutingRuleCondition = new RoutingRuleConditionProperty {
HttpErrorCodeReturnedEquals = "httpErrorCodeReturnedEquals",
KeyPrefixEquals = "keyPrefixEquals"
}
} }
};
Synopsis
Constructors
Website |
Properties
Error |
The name of the error document for the website. |
Index |
The name of the index document for the website. |
Redirect |
The redirect behavior for every request to this bucket's website endpoint. |
Routing |
Rules that define when a redirect is applied and the redirect behavior. |
Constructors
WebsiteConfigurationProperty()
public WebsiteConfigurationProperty()
Properties
ErrorDocument
The name of the error document for the website.
public string ErrorDocument { get; set; }
Property Value
System.
Remarks
IndexDocument
The name of the index document for the website.
public string IndexDocument { get; set; }
Property Value
System.
Remarks
RedirectAllRequestsTo
The redirect behavior for every request to this bucket's website endpoint.
public object RedirectAllRequestsTo { get; set; }
Property Value
System.
Remarks
If you specify this property, you can't specify any other property.
RoutingRules
Rules that define when a redirect is applied and the redirect behavior.
public object RoutingRules { get; set; }
Property Value
System.