software.amazon.awscdk.services.sam

Class CfnApiProps.Builder

java.lang.Object

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

Enclosing interface:

CfnApiProps

@Stability(value=External)
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.core.IResolvable 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.core.IResolvable 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(Object value) Sets the value of DefinitionBody
CfnApiProps.Builder	withDefinitionUri(CfnApi.S3LocationProperty value) Sets the value of DefinitionUri
CfnApiProps.Builder	withDefinitionUri(software.amazon.awscdk.core.IResolvable value) Sets the value of DefinitionUri
CfnApiProps.Builder	withDefinitionUri(String value) Sets the value of DefinitionUri
CfnApiProps.Builder	withEndpointConfiguration(String value) Sets the value of EndpointConfiguration
CfnApiProps.Builder	withMethodSettings(Object 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.core.IResolvable value) Sets the value of TracingEnabled
CfnApiProps.Builder	withVariables(software.amazon.awscdk.core.IResolvable value) Sets the value of Variables
CfnApiProps.Builder	withVariables(Map<String,String> 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

@Stability(value=External)
public CfnApiProps.Builder withStageName(String value)

Sets the value of StageName

Parameters:

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

Returns:

this

withAuth

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

Sets the value of Auth

Parameters:

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

Returns:

this

withAuth

@Stability(value=External)
public CfnApiProps.Builder withAuth(@Nullable
                                                               software.amazon.awscdk.core.IResolvable value)

Sets the value of Auth

Parameters:

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

Returns:

this

withBinaryMediaTypes

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

Sets the value of BinaryMediaTypes

Parameters:

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

Returns:

this

withCacheClusterEnabled

@Stability(value=External)
public CfnApiProps.Builder withCacheClusterEnabled(@Nullable
                                                                              Boolean value)

Sets the value of CacheClusterEnabled

Parameters:

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

Returns:

this

withCacheClusterEnabled

@Stability(value=External)
public CfnApiProps.Builder withCacheClusterEnabled(@Nullable
                                                                              software.amazon.awscdk.core.IResolvable value)

Sets the value of CacheClusterEnabled

Parameters:

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

Returns:

this

withCacheClusterSize

@Stability(value=External)
public CfnApiProps.Builder withCacheClusterSize(@Nullable
                                                                           String value)

Sets the value of CacheClusterSize

Parameters:

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

Returns:

this

withCors

@Stability(value=External)
public CfnApiProps.Builder withCors(@Nullable
                                                               String value)

Sets the value of Cors

Parameters:

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

Returns:

this

withDefinitionBody

@Stability(value=External)
public CfnApiProps.Builder withDefinitionBody(@Nullable
                                                                         Object value)

Sets the value of DefinitionBody

Parameters:

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

Returns:

this

withDefinitionUri

@Stability(value=External)
public CfnApiProps.Builder withDefinitionUri(@Nullable
                                                                        String value)

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

withDefinitionUri

@Stability(value=External)
public CfnApiProps.Builder withDefinitionUri(@Nullable
                                                                        software.amazon.awscdk.core.IResolvable value)

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

withDefinitionUri

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

Sets the value of DefinitionUri

Parameters:

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

Returns:

this

withEndpointConfiguration

@Stability(value=External)
public CfnApiProps.Builder withEndpointConfiguration(@Nullable
                                                                                String value)

Sets the value of EndpointConfiguration

Parameters:

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

Returns:

this

withMethodSettings

@Stability(value=External)
public CfnApiProps.Builder withMethodSettings(@Nullable
                                                                         Object value)

Sets the value of MethodSettings

Parameters:

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

Returns:

this

withName

@Stability(value=External)
public CfnApiProps.Builder withName(@Nullable
                                                               String value)

Sets the value of Name

Parameters:

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

Returns:

this

withTracingEnabled

@Stability(value=External)
public CfnApiProps.Builder withTracingEnabled(@Nullable
                                                                         Boolean value)

Sets the value of TracingEnabled

Parameters:

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

Returns:

this

withTracingEnabled

@Stability(value=External)
public CfnApiProps.Builder withTracingEnabled(@Nullable
                                                                         software.amazon.awscdk.core.IResolvable value)

Sets the value of TracingEnabled

Parameters:

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

Returns:

this

withVariables

@Stability(value=External)
public CfnApiProps.Builder withVariables(@Nullable
                                                                    software.amazon.awscdk.core.IResolvable value)

Sets the value of Variables

Parameters:

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

Returns:

this

withVariables

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

Sets the value of Variables

Parameters:

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

Returns:

this

build

@Stability(value=External)
public CfnApiProps build()

Builds the configured instance.

Returns:

a new instance of CfnApiProps

Throws:

NullPointerException - if any required attribute was not provided