Interface CfnBucket.IWebsiteConfigurationProperty

Specifies website configuration parameters for an Amazon S3 bucket.

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnBucket.IWebsiteConfigurationProperty

Syntax (vb)

Public Interface 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

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.

Properties

ErrorDocument

The name of the error document for the website.

string? ErrorDocument { get; }

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.

string? IndexDocument { get; }

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.

object? RedirectAllRequestsTo { get; }

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

Type union: either IResolvable or CfnBucket.IRedirectAllRequestsToProperty

RoutingRules

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

object? RoutingRules { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnBucket.IRoutingRuleProperty)[]