software.amazon.awscdk.services.sam

Class CfnApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.sam.CfnApiProps.Builder

Enclosing interface:

CfnApiProps

public static final class CfnApiProps.Builder
extends Object

A builder for CfnApiProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnApiProps	build() Builds the configured instance.
CfnApiProps.Builder	withAuth(CfnApi.AuthProperty value) Sets the value of Auth
CfnApiProps.Builder	withAuth(software.amazon.awscdk.Token value) Sets the value of Auth
CfnApiProps.Builder	withBinaryMediaTypes(List<String> value) Sets the value of BinaryMediaTypes
CfnApiProps.Builder	withCacheClusterEnabled(Boolean value) Sets the value of CacheClusterEnabled
CfnApiProps.Builder	withCacheClusterEnabled(software.amazon.awscdk.Token value) Sets the value of CacheClusterEnabled
CfnApiProps.Builder	withCacheClusterSize(String value) Sets the value of CacheClusterSize
CfnApiProps.Builder	withCors(String value) Sets the value of Cors
CfnApiProps.Builder	withDefinitionBody(com.fasterxml.jackson.databind.node.ObjectNode value) Sets the value of DefinitionBody
CfnApiProps.Builder	withDefinitionBody(software.amazon.awscdk.Token value) Sets the value of DefinitionBody
CfnApiProps.Builder	withDefinitionUri(CfnApi.S3LocationProperty value) Sets the value of DefinitionUri
CfnApiProps.Builder	withDefinitionUri(String value) Sets the value of DefinitionUri
CfnApiProps.Builder	withDefinitionUri(software.amazon.awscdk.Token value) Sets the value of DefinitionUri
CfnApiProps.Builder	withEndpointConfiguration(String value) Sets the value of EndpointConfiguration
CfnApiProps.Builder	withMethodSettings(com.fasterxml.jackson.databind.node.ObjectNode value) Sets the value of MethodSettings
CfnApiProps.Builder	withMethodSettings(software.amazon.awscdk.Token value) Sets the value of MethodSettings
CfnApiProps.Builder	withName(String value) Sets the value of Name
CfnApiProps.Builder	withStageName(String value) Sets the value of StageName
CfnApiProps.Builder	withTracingEnabled(Boolean value) Sets the value of TracingEnabled
CfnApiProps.Builder	withTracingEnabled(software.amazon.awscdk.Token value) Sets the value of TracingEnabled
CfnApiProps.Builder	withVariables(Map<String,String> value) Sets the value of Variables
CfnApiProps.Builder	withVariables(software.amazon.awscdk.Token value) Sets the value of Variables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withStageName

public CfnApiProps.Builder withStageName(String value)

Sets the value of StageName

Parameters:

value - `AWS::Serverless::Api.StageName`.

Returns:

this

withAuth

public CfnApiProps.Builder withAuth(@Nullable
                                    CfnApi.AuthProperty value)

Sets the value of Auth

Parameters:

value - `AWS::Serverless::Api.Auth`.

Returns:

this

withAuth

public CfnApiProps.Builder withAuth(@Nullable
                                    software.amazon.awscdk.Token value)

Sets the value of Auth

Parameters:

value - `AWS::Serverless::Api.Auth`.

Returns:

this

withBinaryMediaTypes

public CfnApiProps.Builder withBinaryMediaTypes(@Nullable
                                                List<String> value)

Sets the value of BinaryMediaTypes

Parameters:

value - `AWS::Serverless::Api.BinaryMediaTypes`.

Returns:

this

withCacheClusterEnabled

public CfnApiProps.Builder withCacheClusterEnabled(@Nullable
                                                   Boolean value)

Sets the value of CacheClusterEnabled

Parameters:

value - `AWS::Serverless::Api.CacheClusterEnabled`.

Returns:

this

withCacheClusterEnabled

public CfnApiProps.Builder withCacheClusterEnabled(@Nullable
                                                   software.amazon.awscdk.Token value)

Sets the value of CacheClusterEnabled

Parameters:

value - `AWS::Serverless::Api.CacheClusterEnabled`.

Returns:

this

withCacheClusterSize

public CfnApiProps.Builder withCacheClusterSize(@Nullable
                                                String value)

Sets the value of CacheClusterSize

Parameters:

value - `AWS::Serverless::Api.CacheClusterSize`.

Returns:

this

withCors

public CfnApiProps.Builder withCors(@Nullable
                                    String value)

Sets the value of Cors

Parameters:

value - `AWS::Serverless::Api.Cors`.

Returns:

this

withDefinitionBody

public CfnApiProps.Builder withDefinitionBody(@Nullable
                                              com.fasterxml.jackson.databind.node.ObjectNode value)

Sets the value of DefinitionBody

Parameters:

value - `AWS::Serverless::Api.DefinitionBody`.

Returns:

this

withDefinitionBody

public CfnApiProps.Builder withDefinitionBody(@Nullable
                                              software.amazon.awscdk.Token value)

Sets the value of DefinitionBody

Parameters:

value - `AWS::Serverless::Api.DefinitionBody`.

Returns:

this

withDefinitionUri

public CfnApiProps.Builder withDefinitionUri(@Nullable
                                             String value)

Sets the value of DefinitionUri

Parameters:

value - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

withDefinitionUri

public CfnApiProps.Builder withDefinitionUri(@Nullable
                                             software.amazon.awscdk.Token value)

Sets the value of DefinitionUri

Parameters:

value - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

withDefinitionUri

public CfnApiProps.Builder withDefinitionUri(@Nullable
                                             CfnApi.S3LocationProperty value)

Sets the value of DefinitionUri

Parameters:

value - `AWS::Serverless::Api.DefinitionUri`.

Returns:

this

withEndpointConfiguration

public CfnApiProps.Builder withEndpointConfiguration(@Nullable
                                                     String value)

Sets the value of EndpointConfiguration

Parameters:

value - `AWS::Serverless::Api.EndpointConfiguration`.

Returns:

this

withMethodSettings

public CfnApiProps.Builder withMethodSettings(@Nullable
                                              com.fasterxml.jackson.databind.node.ObjectNode value)

Sets the value of MethodSettings

Parameters:

value - `AWS::Serverless::Api.MethodSettings`.

Returns:

this

withMethodSettings

public CfnApiProps.Builder withMethodSettings(@Nullable
                                              software.amazon.awscdk.Token value)

Sets the value of MethodSettings

Parameters:

value - `AWS::Serverless::Api.MethodSettings`.

Returns:

this

withName

public CfnApiProps.Builder withName(@Nullable
                                    String value)

Sets the value of Name

Parameters:

value - `AWS::Serverless::Api.Name`.

Returns:

this

withTracingEnabled

public CfnApiProps.Builder withTracingEnabled(@Nullable
                                              Boolean value)

Sets the value of TracingEnabled

Parameters:

value - `AWS::Serverless::Api.TracingEnabled`.

Returns:

this

withTracingEnabled

public CfnApiProps.Builder withTracingEnabled(@Nullable
                                              software.amazon.awscdk.Token value)

Sets the value of TracingEnabled

Parameters:

value - `AWS::Serverless::Api.TracingEnabled`.

Returns:

this

withVariables

public CfnApiProps.Builder withVariables(@Nullable
                                         software.amazon.awscdk.Token value)

Sets the value of Variables

Parameters:

value - `AWS::Serverless::Api.Variables`.

Returns:

this

withVariables

public CfnApiProps.Builder withVariables(@Nullable
                                         Map<String,String> value)

Sets the value of Variables

Parameters:

value - `AWS::Serverless::Api.Variables`.

Returns:

this

build

public CfnApiProps build()

Builds the configured instance.

Returns:

a new instance of CfnApiProps

Throws:

NullPointerException - if any required attribute was not provided