software.amazon.awscdk.services.s3

Interface CfnBucket.CorsRuleProperty

All Known Implementing Classes:

CfnBucket.CorsRuleProperty.Jsii$Proxy

Enclosing class:

CfnBucket

public static interface CfnBucket.CorsRuleProperty

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBucket.CorsRuleProperty.Builder	builder()
default java.util.List<java.lang.String>	getAllowedHeaders() Headers that are specified in the `Access-Control-Request-Headers` header.
java.util.List<java.lang.String>	getAllowedMethods() An HTTP method that you allow the origin to run.
java.util.List<java.lang.String>	getAllowedOrigins() One or more origins you want customers to be able to access the bucket from.
default java.util.List<java.lang.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 java.lang.String	getId() A unique identifier for this rule.
default java.lang.Number	getMaxAge() The time in seconds that your browser is to cache the preflight response for the specified resource.

Method Detail

getAllowedMethods

java.util.List<java.lang.String> getAllowedMethods()

An HTTP method that you allow the origin to run.

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

getAllowedOrigins

java.util.List<java.lang.String> getAllowedOrigins()

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

getAllowedHeaders

default java.util.List<java.lang.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.

getExposedHeaders

default java.util.List<java.lang.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).

getId

default java.lang.String getId()

A unique identifier for this rule.

The value must be no more than 255 characters.

getMaxAge

default java.lang.Number getMaxAge()

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

builder

static CfnBucket.CorsRuleProperty.Builder builder()

Returns:

a CfnBucket.CorsRuleProperty.Builder of CfnBucket.CorsRuleProperty