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

DeploymentArgs

data class DeploymentArgs(val deploymentCanarySettings: Output<DeploymentCanarySettingsArgs>? = null, val description: Output<String>? = null, val restApiId: Output<String>? = null, val stageDescription: Output<DeploymentStageDescriptionArgs>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<DeploymentArgs>

The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

Constructors

Link copied to clipboard
fun DeploymentArgs(deploymentCanarySettings: Output<DeploymentCanarySettingsArgs>? = null, description: Output<String>? = null, restApiId: Output<String>? = null, stageDescription: Output<DeploymentStageDescriptionArgs>? = null, stageName: Output<String>? = null)

Functions

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

Properties

Link copied to clipboard
val deploymentCanarySettings: Output<DeploymentCanarySettingsArgs>? = null

The input configuration for a canary deployment.

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

The description for the Deployment resource to create.

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

The string identifier of the associated RestApi.

Link copied to clipboard
val stageDescription: Output<DeploymentStageDescriptionArgs>? = null

The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.

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

The name of the Stage resource for the Deployment resource to create.