Package software.amazon.awscdk.services.s3

Interface CfnBucket.CorsRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.CorsRuleProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.CorsRuleProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a cross-origin access rule for an Amazon S3 bucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 CorsRuleProperty corsRuleProperty = CorsRuleProperty.builder()
         .allowedMethods(List.of("allowedMethods"))
         .allowedOrigins(List.of("allowedOrigins"))
         // the properties below are optional
         .allowedHeaders(List.of("allowedHeaders"))
         .exposedHeaders(List.of("exposedHeaders"))
         .id("id")
         .maxAge(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.CorsRuleProperty.Builder	A builder for CfnBucket.CorsRuleProperty
static final class	CfnBucket.CorsRuleProperty.Jsii$Proxy	An implementation for CfnBucket.CorsRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.CorsRuleProperty.Builder	builder()
default List<String>	getAllowedHeaders()	Headers that are specified in the Access-Control-Request-Headers header.
List<String>	getAllowedMethods()	An HTTP method that you allow the origin to run.
List<String>	getAllowedOrigins()	One or more origins you want customers to be able to access the bucket from.
default List<String>	getExposedHeaders()	One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
default String	getId()	A unique identifier for this rule.
default Number	getMaxAge()	The time in seconds that your browser is to cache the preflight response for the specified resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedMethods

@Stability(Stable)
@NotNull
List<String> getAllowedMethods()

An HTTP method that you allow the origin to run.

Allowed values : GET | PUT | HEAD | POST | DELETE

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedmethods

getAllowedOrigins

@Stability(Stable)
@NotNull
List<String> getAllowedOrigins()

One or more origins you want customers to be able to access the bucket from.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedorigins

getAllowedHeaders

@Stability(Stable)
@Nullable
default List<String> getAllowedHeaders()

Headers that are specified in the Access-Control-Request-Headers header.

These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-allowedheaders

getExposedHeaders

@Stability(Stable)
@Nullable
default List<String> getExposedHeaders()

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-exposedheaders

getId

@Stability(Stable)
@Nullable
default String getId()

A unique identifier for this rule.

The value must be no more than 255 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-id

getMaxAge

@Stability(Stable)
@Nullable
default Number getMaxAge()

The time in seconds that your browser is to cache the preflight response for the specified resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-corsrule.html#cfn-s3-bucket-corsrule-maxage

builder

@Stability(Stable)
static CfnBucket.CorsRuleProperty.Builder builder()

Returns:

a CfnBucket.CorsRuleProperty.Builder of CfnBucket.CorsRuleProperty