aws-cdk-lib.aws_s3.ReplaceKey

ReplaceKey Class

Source

aws-s3/lib/bucket.ts

Example

const bucket = new s3.Bucket(this, 'MyRedirectedBucket', {
  websiteRoutingRules: [
    {
      hostName: 'www.example.com',
      httpRedirectCode: '302',
      protocol: s3.RedirectProtocol.HTTPS,
      replaceKey: s3.ReplaceKey.prefixWith('test/'),
      condition: {
        httpErrorCodeReturnedEquals: '200',
        keyPrefixEquals: 'prefix',
      },
    },
  ],
});

Properties

prefixWithKey?may be undefinedstringprefix_with_key?may be undefinedstrprefixWithKey?may be undefinedStringPrefixWithKey?may be undefinedstringPrefixWithKey?may be undefined*string#

withKey?may be undefinedstringwith_key?may be undefinedstrwithKey?may be undefinedStringWithKey?may be undefinedstringWithKey?may be undefined*string#

Methods

prefixWith(keyReplacement: string): ReplaceKey // chainable@staticmethod def prefix_with(key_replacement: str) -> ReplaceKeypublic static ReplaceKey prefixWith(String keyReplacement)public static ReplaceKey PrefixWith(string keyReplacement)func PrefixWith(KeyReplacement *string) ReplaceKeystatic#

The object key prefix to use in the redirect request.

with(keyReplacement: string): ReplaceKey // chainable@staticmethod def with(key_replacement: str) -> ReplaceKeypublic static ReplaceKey with(String keyReplacement)public static ReplaceKey With(string keyReplacement)func With(KeyReplacement *string) ReplaceKeystatic#

The specific object key to use in the redirect request.