pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin/StageArgs

StageArgs

data class StageArgs(val accessLogSetting: Output<StageAccessLogSettingArgs>? = null, val cacheClusterEnabled: Output<Boolean>? = null, val cacheClusterSize: Output<String>? = null, val canarySetting: Output<StageCanarySettingArgs>? = null, val clientCertificateId: Output<String>? = null, val deploymentId: Output<String>? = null, val description: Output<String>? = null, val documentationVersion: Output<String>? = null, val methodSettings: Output<List<StageMethodSettingArgs>>? = null, val restApiId: Output<String>? = null, val stageName: Output<String>? = null, val tags: Output<List<StageTagArgs>>? = null, val tracingEnabled: Output<Boolean>? = null, val variables: Output<Any>? = null) : ConvertibleToJava<StageArgs>

/* The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.

Constructors

Link copied to clipboard
fun StageArgs(accessLogSetting: Output<StageAccessLogSettingArgs>? = null, cacheClusterEnabled: Output<Boolean>? = null, cacheClusterSize: Output<String>? = null, canarySetting: Output<StageCanarySettingArgs>? = null, clientCertificateId: Output<String>? = null, deploymentId: Output<String>? = null, description: Output<String>? = null, documentationVersion: Output<String>? = null, methodSettings: Output<List<StageMethodSettingArgs>>? = null, restApiId: Output<String>? = null, stageName: Output<String>? = null, tags: Output<List<StageTagArgs>>? = null, tracingEnabled: Output<Boolean>? = null, variables: Output<Any>? = null)

Functions

Link copied to clipboard
open override fun toJava(): StageArgs

Properties

Link copied to clipboard
val accessLogSetting: Output<StageAccessLogSettingArgs>? = null

Access log settings, including the access log format and access log destination ARN.

Link copied to clipboard
val cacheClusterEnabled: Output<Boolean>? = null

Specifies whether a cache cluster is enabled for the stage.

Link copied to clipboard
val cacheClusterSize: Output<String>? = null

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

Link copied to clipboard
val canarySetting: Output<StageCanarySettingArgs>? = null

Settings for the canary deployment in this stage.

Link copied to clipboard
val clientCertificateId: Output<String>? = null

The identifier of a client certificate for an API stage.

Link copied to clipboard
val deploymentId: Output<String>? = null

The identifier of the Deployment that the stage points to.

Link copied to clipboard
val description: Output<String>? = null

The stage's description.

Link copied to clipboard
val documentationVersion: Output<String>? = null

The version of the associated API documentation.

Link copied to clipboard
val methodSettings: Output<List<StageMethodSettingArgs>>? = null

A map that defines the method settings for a Stage resource. Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\*/\*` for overriding all methods in the stage.

Link copied to clipboard
val restApiId: Output<String>? = null

The string identifier of the associated RestApi.

Link copied to clipboard
val stageName: Output<String>? = null

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Link copied to clipboard
val tags: Output<List<StageTagArgs>>? = null

The collection of tags. Each tag element is associated with a given resource.

Link copied to clipboard
val tracingEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val variables: Output<Any>? = null

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-&#46;_~:/?#&=,]+`.