Package software.amazon.awscdk.services.sam

Class CfnApi.Builder

java.lang.Object
software.amazon.awscdk.services.sam.CfnApi.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApi>
Enclosing class:
CfnApi
@Stability(Stable) public static final class CfnApi.Builder extends Object implements software.amazon.jsii.Builder<CfnApi>
A fluent builder for CfnApi.

  • Method Details

    • create

      @Stability(Stable) public static CfnApi.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnApi.Builder.

    • stageName

      @Stability(Stable) public CfnApi.Builder stageName(String stageName)
      AWS::Serverless::Api.StageName.

      Parameters:
      stageName - AWS::Serverless::Api.StageName. This parameter is required.
      Returns:
      this

    • accessLogSetting

      @Stability(Stable) public CfnApi.Builder accessLogSetting(CfnApi.AccessLogSettingProperty accessLogSetting)
      AWS::Serverless::Api.AccessLogSetting.

      Parameters:
      accessLogSetting - AWS::Serverless::Api.AccessLogSetting. This parameter is required.
      Returns:
      this

    • accessLogSetting

      @Stability(Stable) public CfnApi.Builder accessLogSetting(IResolvable accessLogSetting)
      AWS::Serverless::Api.AccessLogSetting.

      Parameters:
      accessLogSetting - AWS::Serverless::Api.AccessLogSetting. This parameter is required.
      Returns:
      this

    • auth

      @Stability(Stable) public CfnApi.Builder auth(IResolvable auth)
      AWS::Serverless::Api.Auth.

      Parameters:
      auth - AWS::Serverless::Api.Auth. This parameter is required.
      Returns:
      this

    • auth

      @Stability(Stable) public CfnApi.Builder auth(CfnApi.AuthProperty auth)
      AWS::Serverless::Api.Auth.

      Parameters:
      auth - AWS::Serverless::Api.Auth. This parameter is required.
      Returns:
      this

    • binaryMediaTypes

      @Stability(Stable) public CfnApi.Builder binaryMediaTypes(List<String> binaryMediaTypes)
      AWS::Serverless::Api.BinaryMediaTypes.

      Parameters:
      binaryMediaTypes - AWS::Serverless::Api.BinaryMediaTypes. This parameter is required.
      Returns:
      this

    • cacheClusterEnabled

      @Stability(Stable) public CfnApi.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)
      AWS::Serverless::Api.CacheClusterEnabled.

      Parameters:
      cacheClusterEnabled - AWS::Serverless::Api.CacheClusterEnabled. This parameter is required.
      Returns:
      this

    • cacheClusterEnabled

      @Stability(Stable) public CfnApi.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)
      AWS::Serverless::Api.CacheClusterEnabled.

      Parameters:
      cacheClusterEnabled - AWS::Serverless::Api.CacheClusterEnabled. This parameter is required.
      Returns:
      this

    • cacheClusterSize

      @Stability(Stable) public CfnApi.Builder cacheClusterSize(String cacheClusterSize)
      AWS::Serverless::Api.CacheClusterSize.

      Parameters:
      cacheClusterSize - AWS::Serverless::Api.CacheClusterSize. This parameter is required.
      Returns:
      this

    • canarySetting

      @Stability(Stable) public CfnApi.Builder canarySetting(IResolvable canarySetting)
      AWS::Serverless::Api.CanarySetting.

      Parameters:
      canarySetting - AWS::Serverless::Api.CanarySetting. This parameter is required.
      Returns:
      this

    • canarySetting

      @Stability(Stable) public CfnApi.Builder canarySetting(CfnApi.CanarySettingProperty canarySetting)
      AWS::Serverless::Api.CanarySetting.

      Parameters:
      canarySetting - AWS::Serverless::Api.CanarySetting. This parameter is required.
      Returns:
      this

    • cors

      @Stability(Stable) public CfnApi.Builder cors(String cors)
      AWS::Serverless::Api.Cors.

      Parameters:
      cors - AWS::Serverless::Api.Cors. This parameter is required.
      Returns:
      this

    • cors

      @Stability(Stable) public CfnApi.Builder cors(IResolvable cors)
      AWS::Serverless::Api.Cors.

      Parameters:
      cors - AWS::Serverless::Api.Cors. This parameter is required.
      Returns:
      this

    • cors

      @Stability(Stable) public CfnApi.Builder cors(CfnApi.CorsConfigurationProperty cors)
      AWS::Serverless::Api.Cors.

      Parameters:
      cors - AWS::Serverless::Api.Cors. This parameter is required.
      Returns:
      this

    • definitionBody

      @Stability(Stable) public CfnApi.Builder definitionBody(Object definitionBody)
      AWS::Serverless::Api.DefinitionBody.

      Parameters:
      definitionBody - AWS::Serverless::Api.DefinitionBody. This parameter is required.
      Returns:
      this

    • definitionUri

      @Stability(Stable) public CfnApi.Builder definitionUri(String definitionUri)
      AWS::Serverless::Api.DefinitionUri.

      Parameters:
      definitionUri - AWS::Serverless::Api.DefinitionUri. This parameter is required.
      Returns:
      this

    • definitionUri

      @Stability(Stable) public CfnApi.Builder definitionUri(IResolvable definitionUri)
      AWS::Serverless::Api.DefinitionUri.

      Parameters:
      definitionUri - AWS::Serverless::Api.DefinitionUri. This parameter is required.
      Returns:
      this

    • definitionUri

      @Stability(Stable) public CfnApi.Builder definitionUri(CfnApi.S3LocationProperty definitionUri)
      AWS::Serverless::Api.DefinitionUri.

      Parameters:
      definitionUri - AWS::Serverless::Api.DefinitionUri. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnApi.Builder description(String description)
      AWS::Serverless::Api.Description.

      Parameters:
      description - AWS::Serverless::Api.Description. This parameter is required.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
      AWS::Serverless::Api.DisableExecuteApiEndpoint.

      Parameters:
      disableExecuteApiEndpoint - AWS::Serverless::Api.DisableExecuteApiEndpoint. This parameter is required.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
      AWS::Serverless::Api.DisableExecuteApiEndpoint.

      Parameters:
      disableExecuteApiEndpoint - AWS::Serverless::Api.DisableExecuteApiEndpoint. This parameter is required.
      Returns:
      this

    • domain

      @Stability(Stable) public CfnApi.Builder domain(IResolvable domain)
      AWS::Serverless::Api.Domain.

      Parameters:
      domain - AWS::Serverless::Api.Domain. This parameter is required.
      Returns:
      this

    • domain

      @Stability(Stable) public CfnApi.Builder domain(CfnApi.DomainConfigurationProperty domain)
      AWS::Serverless::Api.Domain.

      Parameters:
      domain - AWS::Serverless::Api.Domain. This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnApi.Builder endpointConfiguration(String endpointConfiguration)
      AWS::Serverless::Api.EndpointConfiguration.

      Parameters:
      endpointConfiguration - AWS::Serverless::Api.EndpointConfiguration. This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnApi.Builder endpointConfiguration(IResolvable endpointConfiguration)
      AWS::Serverless::Api.EndpointConfiguration.

      Parameters:
      endpointConfiguration - AWS::Serverless::Api.EndpointConfiguration. This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnApi.Builder endpointConfiguration(CfnApi.EndpointConfigurationProperty endpointConfiguration)
      AWS::Serverless::Api.EndpointConfiguration.

      Parameters:
      endpointConfiguration - AWS::Serverless::Api.EndpointConfiguration. This parameter is required.
      Returns:
      this

    • gatewayResponses

      @Stability(Stable) public CfnApi.Builder gatewayResponses(Object gatewayResponses)
      AWS::Serverless::Api.GatewayResponses.

      Parameters:
      gatewayResponses - AWS::Serverless::Api.GatewayResponses. This parameter is required.
      Returns:
      this

    • methodSettings

      @Stability(Stable) public CfnApi.Builder methodSettings(List<? extends Object> methodSettings)
      AWS::Serverless::Api.MethodSettings.

      Parameters:
      methodSettings - AWS::Serverless::Api.MethodSettings. This parameter is required.
      Returns:
      this

    • methodSettings

      @Stability(Stable) public CfnApi.Builder methodSettings(IResolvable methodSettings)
      AWS::Serverless::Api.MethodSettings.

      Parameters:
      methodSettings - AWS::Serverless::Api.MethodSettings. This parameter is required.
      Returns:
      this

    • minimumCompressionSize

      @Stability(Stable) public CfnApi.Builder minimumCompressionSize(Number minimumCompressionSize)
      AWS::Serverless::Api.MinimumCompressionSize.

      Parameters:
      minimumCompressionSize - AWS::Serverless::Api.MinimumCompressionSize. This parameter is required.
      Returns:
      this

    • models

      @Stability(Stable) public CfnApi.Builder models(Object models)
      AWS::Serverless::Api.Models.

      Parameters:
      models - AWS::Serverless::Api.Models. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnApi.Builder name(String name)
      AWS::Serverless::Api.Name.

      Parameters:
      name - AWS::Serverless::Api.Name. This parameter is required.
      Returns:
      this

    • openApiVersion

      @Stability(Stable) public CfnApi.Builder openApiVersion(String openApiVersion)
      AWS::Serverless::Api.OpenApiVersion.

      Parameters:
      openApiVersion - AWS::Serverless::Api.OpenApiVersion. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnApi.Builder tags(Map<String,String> tags)
      AWS::Serverless::Api.Tags.

      Parameters:
      tags - AWS::Serverless::Api.Tags. This parameter is required.
      Returns:
      this

    • tracingEnabled

      @Stability(Stable) public CfnApi.Builder tracingEnabled(Boolean tracingEnabled)
      AWS::Serverless::Api.TracingEnabled.

      Parameters:
      tracingEnabled - AWS::Serverless::Api.TracingEnabled. This parameter is required.
      Returns:
      this

    • tracingEnabled

      @Stability(Stable) public CfnApi.Builder tracingEnabled(IResolvable tracingEnabled)
      AWS::Serverless::Api.TracingEnabled.

      Parameters:
      tracingEnabled - AWS::Serverless::Api.TracingEnabled. This parameter is required.
      Returns:
      this

    • variables

      @Stability(Stable) public CfnApi.Builder variables(IResolvable variables)
      AWS::Serverless::Api.Variables.

      Parameters:
      variables - AWS::Serverless::Api.Variables. This parameter is required.
      Returns:
      this

    • variables

      @Stability(Stable) public CfnApi.Builder variables(Map<String,String> variables)
      AWS::Serverless::Api.Variables.

      Parameters:
      variables - AWS::Serverless::Api.Variables. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnApi build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnApi>
      Returns:
      a newly built instance of CfnApi.