Class CfnBucket.WebsiteConfigurationProperty

Specifies website configuration parameters for an Amazon S3 bucket.

Inheritance

object

CfnBucket.WebsiteConfigurationProperty

Implements

CfnBucket.IWebsiteConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBucket.WebsiteConfigurationProperty : CfnBucket.IWebsiteConfigurationProperty

Syntax (vb)

Public Class CfnBucket.WebsiteConfigurationProperty Implements CfnBucket.IWebsiteConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html

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

WebsiteConfigurationProperty()

Specifies website configuration parameters for an Amazon S3 bucket.

Properties

ErrorDocument	The name of the error document for the website.
IndexDocument	The name of the index document for the website.
RedirectAllRequestsTo	The redirect behavior for every request to this bucket's website endpoint.
RoutingRules	Rules that define when a redirect is applied and the redirect behavior.

Constructors

WebsiteConfigurationProperty()

Specifies website configuration parameters for an Amazon S3 bucket.

public WebsiteConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html

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"
                     }
                 } }
             };

Properties

ErrorDocument

The name of the error document for the website.

public string? ErrorDocument { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-errordocument

IndexDocument

The name of the index document for the website.

public string? IndexDocument { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-indexdocument

RedirectAllRequestsTo

The redirect behavior for every request to this bucket's website endpoint.

public object? RedirectAllRequestsTo { get; set; }

Property Value

object

Remarks

If you specify this property, you can't specify any other property.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-redirectallrequeststo

RoutingRules

Rules that define when a redirect is applied and the redirect behavior.

public object? RoutingRules { get; set; }