Package software.amazon.awscdk.services.sam

Interface CfnApi.AuthProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.AuthProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.AuthProperty
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.*;
 Object authorizers;
 AuthProperty authProperty = AuthProperty.builder()
         .addDefaultAuthorizerToCorsPreflight(false)
         .authorizers(authorizers)
         .defaultAuthorizer("defaultAuthorizer")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.AuthProperty.Builder	builder()
default Object	getAddDefaultAuthorizerToCorsPreflight()	Returns union: either Boolean or IResolvable
default Object	getAuthorizers()
default String	getDefaultAuthorizer()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddDefaultAuthorizerToCorsPreflight

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

Returns union: either Boolean or IResolvable

See Also:

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

getAuthorizers

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

See Also:

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

getDefaultAuthorizer

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

See Also:

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

builder

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

Returns:

a CfnApi.AuthProperty.Builder of CfnApi.AuthProperty