apigateway/aws.sdk.kotlin.services.apigateway.model/CreateStageRequest/Builder

Builder

Properties

cacheClusterEnabled

var cacheClusterEnabled: Boolean?

Whether cache clustering is enabled for the stage.

cacheClusterSize

var cacheClusterSize: CacheClusterSize?

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

var canarySettings: CanarySettings?

The canary deployment settings of this stage.

var deploymentId: String?

The identifier of the Deployment resource for the Stage resource.

var description: String?

The description of the Stage resource.

documentationVersion

var documentationVersion: String?

The version of the associated API documentation.

var restApiId: String?

The string identifier of the associated RestApi.

var stageName: String?

The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

var tags: Map<String, String>?

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

var tracingEnabled: Boolean?

Specifies whether active tracing with X-ray is enabled for the Stage.

var variables: Map<String, String>?

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Functions

fun canarySettings(block: CanarySettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.apigateway.model.CanarySettings inside the given block