CfnStageProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.6 API)

java.lang.Object
- software.amazon.awscdk.services.apigateway.CfnStageProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnStageProps>

Enclosing interface:: CfnStageProps

@Stability(value=Stable)
public static final class CfnStageProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStageProps>

A builder for CfnStageProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnStageProps.Builder`	`accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting)` Sets the value of `CfnStageProps.getAccessLogSetting()`
`CfnStageProps.Builder`	`accessLogSetting(IResolvable accessLogSetting)` Sets the value of `CfnStageProps.getAccessLogSetting()`
`CfnStageProps`	`build()` Builds the configured instance.
`CfnStageProps.Builder`	`cacheClusterEnabled(Boolean cacheClusterEnabled)` Sets the value of `CfnStageProps.getCacheClusterEnabled()`
`CfnStageProps.Builder`	`cacheClusterEnabled(IResolvable cacheClusterEnabled)` Sets the value of `CfnStageProps.getCacheClusterEnabled()`
`CfnStageProps.Builder`	`cacheClusterSize(String cacheClusterSize)` Sets the value of `CfnStageProps.getCacheClusterSize()`
`CfnStageProps.Builder`	`canarySetting(CfnStage.CanarySettingProperty canarySetting)` Sets the value of `CfnStageProps.getCanarySetting()`
`CfnStageProps.Builder`	`canarySetting(IResolvable canarySetting)` Sets the value of `CfnStageProps.getCanarySetting()`
`CfnStageProps.Builder`	`clientCertificateId(String clientCertificateId)` Sets the value of `CfnStageProps.getClientCertificateId()`
`CfnStageProps.Builder`	`deploymentId(String deploymentId)` Sets the value of `CfnStageProps.getDeploymentId()`
`CfnStageProps.Builder`	`description(String description)` Sets the value of `CfnStageProps.getDescription()`
`CfnStageProps.Builder`	`documentationVersion(String documentationVersion)` Sets the value of `CfnStageProps.getDocumentationVersion()`
`CfnStageProps.Builder`	`methodSettings(IResolvable methodSettings)` Sets the value of `CfnStageProps.getMethodSettings()`
`CfnStageProps.Builder`	`methodSettings(List<? extends Object> methodSettings)` Sets the value of `CfnStageProps.getMethodSettings()`
`CfnStageProps.Builder`	`restApiId(String restApiId)` Sets the value of `CfnStageProps.getRestApiId()`
`CfnStageProps.Builder`	`stageName(String stageName)` Sets the value of `CfnStageProps.getStageName()`
`CfnStageProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnStageProps.getTags()`
`CfnStageProps.Builder`	`tracingEnabled(Boolean tracingEnabled)` Sets the value of `CfnStageProps.getTracingEnabled()`
`CfnStageProps.Builder`	`tracingEnabled(IResolvable tracingEnabled)` Sets the value of `CfnStageProps.getTracingEnabled()`
`CfnStageProps.Builder`	`variables(IResolvable variables)` Sets the value of `CfnStageProps.getVariables()`
`CfnStageProps.Builder`	`variables(Map<String,String> variables)` Sets the value of `CfnStageProps.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
  - restApiId
```
@Stability(value=Stable)
public CfnStageProps.Builder restApiId(String restApiId)
```
    Sets the value of CfnStageProps.getRestApiId()
    
    Parameters:
    
    restApiId - `AWS::ApiGateway::Stage.RestApiId`. This parameter is required.
    
    Returns:
    
    this
  - accessLogSetting
```
@Stability(value=Stable)
public CfnStageProps.Builder accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting)
```
    Sets the value of CfnStageProps.getAccessLogSetting()
    
    Parameters:
    
    accessLogSetting - `AWS::ApiGateway::Stage.AccessLogSetting`.
    
    Returns:
    
    this
  - accessLogSetting
```
@Stability(value=Stable)
public CfnStageProps.Builder accessLogSetting(IResolvable accessLogSetting)
```
    Sets the value of CfnStageProps.getAccessLogSetting()
    
    Parameters:
    
    accessLogSetting - `AWS::ApiGateway::Stage.AccessLogSetting`.
    
    Returns:
    
    this
  - cacheClusterEnabled
```
@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)
```
    Sets the value of CfnStageProps.getCacheClusterEnabled()
    
    Parameters:
    
    cacheClusterEnabled - `AWS::ApiGateway::Stage.CacheClusterEnabled`.
    
    Returns:
    
    this
  - cacheClusterEnabled
```
@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled)
```
    Sets the value of CfnStageProps.getCacheClusterEnabled()
    
    Parameters:
    
    cacheClusterEnabled - `AWS::ApiGateway::Stage.CacheClusterEnabled`.
    
    Returns:
    
    this
  - cacheClusterSize
```
@Stability(value=Stable)
public CfnStageProps.Builder cacheClusterSize(String cacheClusterSize)
```
    Sets the value of CfnStageProps.getCacheClusterSize()
    
    Parameters:
    
    cacheClusterSize - `AWS::ApiGateway::Stage.CacheClusterSize`.
    
    Returns:
    
    this
  - canarySetting
```
@Stability(value=Stable)
public CfnStageProps.Builder canarySetting(CfnStage.CanarySettingProperty canarySetting)
```
    Sets the value of CfnStageProps.getCanarySetting()
    
    Parameters:
    
    canarySetting - `AWS::ApiGateway::Stage.CanarySetting`.
    
    Returns:
    
    this
  - canarySetting
```
@Stability(value=Stable)
public CfnStageProps.Builder canarySetting(IResolvable canarySetting)
```
    Sets the value of CfnStageProps.getCanarySetting()
    
    Parameters:
    
    canarySetting - `AWS::ApiGateway::Stage.CanarySetting`.
    
    Returns:
    
    this
  - clientCertificateId
```
@Stability(value=Stable)
public CfnStageProps.Builder clientCertificateId(String clientCertificateId)
```
    Sets the value of CfnStageProps.getClientCertificateId()
    
    Parameters:
    
    clientCertificateId - `AWS::ApiGateway::Stage.ClientCertificateId`.
    
    Returns:
    
    this
  - deploymentId
```
@Stability(value=Stable)
public CfnStageProps.Builder deploymentId(String deploymentId)
```
    Sets the value of CfnStageProps.getDeploymentId()
    
    Parameters:
    
    deploymentId - `AWS::ApiGateway::Stage.DeploymentId`.
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnStageProps.Builder description(String description)
```
    Sets the value of CfnStageProps.getDescription()
    
    Parameters:
    
    description - `AWS::ApiGateway::Stage.Description`.
    
    Returns:
    
    this
  - documentationVersion
```
@Stability(value=Stable)
public CfnStageProps.Builder documentationVersion(String documentationVersion)
```
    Sets the value of CfnStageProps.getDocumentationVersion()
    
    Parameters:
    
    documentationVersion - `AWS::ApiGateway::Stage.DocumentationVersion`.
    
    Returns:
    
    this
  - methodSettings
```
@Stability(value=Stable)
public CfnStageProps.Builder methodSettings(IResolvable methodSettings)
```
    Sets the value of CfnStageProps.getMethodSettings()
    
    Parameters:
    
    methodSettings - `AWS::ApiGateway::Stage.MethodSettings`.
    
    Returns:
    
    this
  - methodSettings
```
@Stability(value=Stable)
public CfnStageProps.Builder methodSettings(List<? extends Object> methodSettings)
```
    Sets the value of CfnStageProps.getMethodSettings()
    
    Parameters:
    
    methodSettings - `AWS::ApiGateway::Stage.MethodSettings`.
    
    Returns:
    
    this
  - stageName
```
@Stability(value=Stable)
public CfnStageProps.Builder stageName(String stageName)
```
    Sets the value of CfnStageProps.getStageName()
    
    Parameters:
    
    stageName - `AWS::ApiGateway::Stage.StageName`.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnStageProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnStageProps.getTags()
    
    Parameters:
    
    tags - `AWS::ApiGateway::Stage.Tags`.
    
    Returns:
    
    this
  - tracingEnabled
```
@Stability(value=Stable)
public CfnStageProps.Builder tracingEnabled(Boolean tracingEnabled)
```
    Sets the value of CfnStageProps.getTracingEnabled()
    
    Parameters:
    
    tracingEnabled - `AWS::ApiGateway::Stage.TracingEnabled`.
    
    Returns:
    
    this
  - tracingEnabled
```
@Stability(value=Stable)
public CfnStageProps.Builder tracingEnabled(IResolvable tracingEnabled)
```
    Sets the value of CfnStageProps.getTracingEnabled()
    
    Parameters:
    
    tracingEnabled - `AWS::ApiGateway::Stage.TracingEnabled`.
    
    Returns:
    
    this
  - variables
```
@Stability(value=Stable)
public CfnStageProps.Builder variables(IResolvable variables)
```
    Sets the value of CfnStageProps.getVariables()
    
    Parameters:
    
    variables - `AWS::ApiGateway::Stage.Variables`.
    
    Returns:
    
    this
  - variables
```
@Stability(value=Stable)
public CfnStageProps.Builder variables(Map<String,String> variables)
```
    Sets the value of CfnStageProps.getVariables()
    
    Parameters:
    
    variables - `AWS::ApiGateway::Stage.Variables`.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnStageProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnStageProps>
    
    Returns:
    
    a new instance of CfnStageProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnStageProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

restApiId

accessLogSetting

accessLogSetting

cacheClusterEnabled

cacheClusterEnabled

cacheClusterSize

canarySetting

canarySetting

clientCertificateId

deploymentId

description

documentationVersion

methodSettings

methodSettings

stageName

tags

tracingEnabled

tracingEnabled

variables

variables

build