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 java.lang.Object

A builder for CfnApiProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnApiProps.Builder	accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting) Sets the value of CfnApiProps.getAccessLogSetting()
CfnApiProps.Builder	accessLogSetting(IResolvable accessLogSetting) Sets the value of CfnApiProps.getAccessLogSetting()
CfnApiProps.Builder	auth(CfnApi.AuthProperty auth) Sets the value of CfnApiProps.getAuth()
CfnApiProps.Builder	auth(IResolvable auth) Sets the value of CfnApiProps.getAuth()
CfnApiProps.Builder	binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes) Sets the value of CfnApiProps.getBinaryMediaTypes()
CfnApiProps	build() Builds the configured instance.
CfnApiProps.Builder	cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled) Sets the value of CfnApiProps.getCacheClusterEnabled()
CfnApiProps.Builder	cacheClusterEnabled(IResolvable cacheClusterEnabled) Sets the value of CfnApiProps.getCacheClusterEnabled()
CfnApiProps.Builder	cacheClusterSize(java.lang.String cacheClusterSize) Sets the value of CfnApiProps.getCacheClusterSize()
CfnApiProps.Builder	canarySetting(CfnApi.CanarySettingProperty canarySetting) Sets the value of CfnApiProps.getCanarySetting()
CfnApiProps.Builder	canarySetting(IResolvable canarySetting) Sets the value of CfnApiProps.getCanarySetting()
CfnApiProps.Builder	cors(CfnApi.CorsConfigurationProperty cors) Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	cors(IResolvable cors) Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	cors(java.lang.String cors) Sets the value of CfnApiProps.getCors()
CfnApiProps.Builder	definitionBody(java.lang.Object definitionBody) Sets the value of CfnApiProps.getDefinitionBody()
CfnApiProps.Builder	definitionUri(CfnApi.S3LocationProperty definitionUri) Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	definitionUri(IResolvable definitionUri) Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	definitionUri(java.lang.String definitionUri) Sets the value of CfnApiProps.getDefinitionUri()
CfnApiProps.Builder	description(java.lang.String description) Sets the value of CfnApiProps.getDescription()
CfnApiProps.Builder	domain(CfnApi.DomainConfigurationProperty domain) Sets the value of CfnApiProps.getDomain()
CfnApiProps.Builder	domain(IResolvable domain) Sets the value of CfnApiProps.getDomain()
CfnApiProps.Builder	endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration) Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	endpointConfiguration(IResolvable endpointConfiguration) Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	endpointConfiguration(java.lang.String endpointConfiguration) Sets the value of CfnApiProps.getEndpointConfiguration()
CfnApiProps.Builder	gatewayResponses(java.lang.Object gatewayResponses) Sets the value of CfnApiProps.getGatewayResponses()
CfnApiProps.Builder	methodSettings(IResolvable methodSettings) Sets the value of CfnApiProps.getMethodSettings()
CfnApiProps.Builder	methodSettings(java.util.List<? extends java.lang.Object> methodSettings) Sets the value of CfnApiProps.getMethodSettings()
CfnApiProps.Builder	minimumCompressionSize(java.lang.Number minimumCompressionSize) Sets the value of CfnApiProps.getMinimumCompressionSize()
CfnApiProps.Builder	models(java.lang.Object models) Sets the value of CfnApiProps.getModels()
CfnApiProps.Builder	name(java.lang.String name) Sets the value of CfnApiProps.getName()
CfnApiProps.Builder	openApiVersion(java.lang.String openApiVersion) Sets the value of CfnApiProps.getOpenApiVersion()
CfnApiProps.Builder	stageName(java.lang.String stageName) Sets the value of CfnApiProps.getStageName()
CfnApiProps.Builder	tags(java.util.Map<java.lang.String,java.lang.String> tags) Sets the value of CfnApiProps.getTags()
CfnApiProps.Builder	tracingEnabled(java.lang.Boolean tracingEnabled) Sets the value of CfnApiProps.getTracingEnabled()
CfnApiProps.Builder	tracingEnabled(IResolvable tracingEnabled) Sets the value of CfnApiProps.getTracingEnabled()
CfnApiProps.Builder	variables(IResolvable variables) Sets the value of CfnApiProps.getVariables()
CfnApiProps.Builder	variables(java.util.Map<java.lang.String,java.lang.String> variables) Sets the value of CfnApiProps.getVariables()

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

stageName

public CfnApiProps.Builder stageName(java.lang.String stageName)

Sets the value of CfnApiProps.getStageName()

Parameters:

stageName - `AWS::Serverless::Api.StageName`. This parameter is required.

Returns:

this

accessLogSetting

public CfnApiProps.Builder accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)

Sets the value of CfnApiProps.getAccessLogSetting()

Parameters:

accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`.

Returns:

this

accessLogSetting

public CfnApiProps.Builder accessLogSetting(IResolvable accessLogSetting)

Sets the value of CfnApiProps.getAccessLogSetting()

Parameters:

accessLogSetting - `AWS::Serverless::Api.AccessLogSetting`.

Returns:

this

auth

public CfnApiProps.Builder auth(IResolvable auth)

Sets the value of CfnApiProps.getAuth()

Parameters:

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

Returns:

this

auth

public CfnApiProps.Builder auth(CfnApi.AuthProperty auth)

Sets the value of CfnApiProps.getAuth()

Parameters:

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

Returns:

this

binaryMediaTypes

public CfnApiProps.Builder binaryMediaTypes(java.util.List<java.lang.String> binaryMediaTypes)

Sets the value of CfnApiProps.getBinaryMediaTypes()

Parameters:

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

Returns:

this

cacheClusterEnabled

public CfnApiProps.Builder cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled)

Sets the value of CfnApiProps.getCacheClusterEnabled()

Parameters:

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

Returns:

this

cacheClusterEnabled

public CfnApiProps.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)

Sets the value of CfnApiProps.getCacheClusterEnabled()

Parameters:

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

Returns:

this

cacheClusterSize

public CfnApiProps.Builder cacheClusterSize(java.lang.String cacheClusterSize)

Sets the value of CfnApiProps.getCacheClusterSize()

Parameters:

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

Returns:

this

canarySetting

public CfnApiProps.Builder canarySetting(IResolvable canarySetting)

Sets the value of CfnApiProps.getCanarySetting()

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`.

Returns:

this

canarySetting

public CfnApiProps.Builder canarySetting(CfnApi.CanarySettingProperty canarySetting)

Sets the value of CfnApiProps.getCanarySetting()

Parameters:

canarySetting - `AWS::Serverless::Api.CanarySetting`.

Returns:

this

cors

public CfnApiProps.Builder cors(java.lang.String cors)

Sets the value of CfnApiProps.getCors()

Parameters:

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

Returns:

this

cors

public CfnApiProps.Builder cors(IResolvable cors)

Sets the value of CfnApiProps.getCors()

Parameters:

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

Returns:

this

cors

public CfnApiProps.Builder cors(CfnApi.CorsConfigurationProperty cors)

Sets the value of CfnApiProps.getCors()

Parameters:

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

Returns:

this

definitionBody

public CfnApiProps.Builder definitionBody(java.lang.Object definitionBody)

Sets the value of CfnApiProps.getDefinitionBody()

Parameters:

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

Returns:

this

definitionUri

public CfnApiProps.Builder definitionUri(java.lang.String definitionUri)

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

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

Returns:

this

definitionUri

public CfnApiProps.Builder definitionUri(IResolvable definitionUri)

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

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

Returns:

this

definitionUri

public CfnApiProps.Builder definitionUri(CfnApi.S3LocationProperty definitionUri)

Sets the value of CfnApiProps.getDefinitionUri()

Parameters:

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

Returns:

this

description

public CfnApiProps.Builder description(java.lang.String description)

Sets the value of CfnApiProps.getDescription()

Parameters:

description - `AWS::Serverless::Api.Description`.

Returns:

this

domain

public CfnApiProps.Builder domain(IResolvable domain)

Sets the value of CfnApiProps.getDomain()

Parameters:

domain - `AWS::Serverless::Api.Domain`.

Returns:

this

domain

public CfnApiProps.Builder domain(CfnApi.DomainConfigurationProperty domain)

Sets the value of CfnApiProps.getDomain()

Parameters:

domain - `AWS::Serverless::Api.Domain`.

Returns:

this

endpointConfiguration

public CfnApiProps.Builder endpointConfiguration(java.lang.String endpointConfiguration)

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

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

Returns:

this

endpointConfiguration

public CfnApiProps.Builder endpointConfiguration(IResolvable endpointConfiguration)

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

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

Returns:

this

endpointConfiguration

public CfnApiProps.Builder endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)

Sets the value of CfnApiProps.getEndpointConfiguration()

Parameters:

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

Returns:

this

gatewayResponses

public CfnApiProps.Builder gatewayResponses(java.lang.Object gatewayResponses)

Sets the value of CfnApiProps.getGatewayResponses()

Parameters:

gatewayResponses - `AWS::Serverless::Api.GatewayResponses`.

Returns:

this

methodSettings

public CfnApiProps.Builder methodSettings(java.util.List<? extends java.lang.Object> methodSettings)

Sets the value of CfnApiProps.getMethodSettings()

Parameters:

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

Returns:

this

methodSettings

public CfnApiProps.Builder methodSettings(IResolvable methodSettings)

Sets the value of CfnApiProps.getMethodSettings()

Parameters:

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

Returns:

this

minimumCompressionSize

public CfnApiProps.Builder minimumCompressionSize(java.lang.Number minimumCompressionSize)

Sets the value of CfnApiProps.getMinimumCompressionSize()

Parameters:

minimumCompressionSize - `AWS::Serverless::Api.MinimumCompressionSize`.

Returns:

this

models

public CfnApiProps.Builder models(java.lang.Object models)

Sets the value of CfnApiProps.getModels()

Parameters:

models - `AWS::Serverless::Api.Models`.

Returns:

this

name

public CfnApiProps.Builder name(java.lang.String name)

Sets the value of CfnApiProps.getName()

Parameters:

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

Returns:

this

openApiVersion

public CfnApiProps.Builder openApiVersion(java.lang.String openApiVersion)

Sets the value of CfnApiProps.getOpenApiVersion()

Parameters:

openApiVersion - `AWS::Serverless::Api.OpenApiVersion`.

Returns:

this

tags

public CfnApiProps.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)

Sets the value of CfnApiProps.getTags()

Parameters:

tags - `AWS::Serverless::Api.Tags`.

Returns:

this

tracingEnabled

public CfnApiProps.Builder tracingEnabled(java.lang.Boolean tracingEnabled)

Sets the value of CfnApiProps.getTracingEnabled()

Parameters:

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

Returns:

this

tracingEnabled

public CfnApiProps.Builder tracingEnabled(IResolvable tracingEnabled)

Sets the value of CfnApiProps.getTracingEnabled()

Parameters:

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

Returns:

this

variables

public CfnApiProps.Builder variables(IResolvable variables)

Sets the value of CfnApiProps.getVariables()

Parameters:

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

Returns:

this

variables

public CfnApiProps.Builder variables(java.util.Map<java.lang.String,java.lang.String> variables)

Sets the value of CfnApiProps.getVariables()

Parameters:

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

Returns:

this

build

public CfnApiProps build()

Builds the configured instance.

Returns:

a new instance of CfnApiProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided