Package software.amazon.awscdk.services.sam

Interface CfnApi.CorsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.CorsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.CorsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.sam.*;
 CorsConfigurationProperty corsConfigurationProperty = CorsConfigurationProperty.builder()
         .allowOrigin("allowOrigin")
         // the properties below are optional
         .allowCredentials(false)
         .allowHeaders("allowHeaders")
         .allowMethods("allowMethods")
         .maxAge("maxAge")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.CorsConfigurationProperty.Builder	builder()
default Object	getAllowCredentials()	Returns union: either Boolean or IResolvable
default String	getAllowHeaders()
default String	getAllowMethods()
String	getAllowOrigin()
default String	getMaxAge()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowOrigin

@Stability(Stable)
@NotNull
String getAllowOrigin()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-alloworigin

getAllowCredentials

@Stability(Stable)
@Nullable
default Object getAllowCredentials()

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowcredentials

getAllowHeaders

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowheaders

getAllowMethods

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowmethods

getMaxAge

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-maxage

builder

@Stability(Stable)
static CfnApi.CorsConfigurationProperty.Builder builder()

Returns:

a CfnApi.CorsConfigurationProperty.Builder of CfnApi.CorsConfigurationProperty