cloudshift.awscdk.dsl.services.apigatewayv2.CfnDeploymentDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.apigatewayv2
import cloudshift.awscdk.common.CdkDslMarker
import kotlin.String
import software.amazon.awscdk.services.apigatewayv2.CfnDeployment
import software.constructs.Construct
/**
* The `AWS::ApiGatewayV2::Deployment` resource creates a deployment for an API.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.apigatewayv2.*;
* CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
* .apiId("apiId")
* // the properties below are optional
* .description("description")
* .stageName("stageName")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html)
*/
@CdkDslMarker
public class CfnDeploymentDsl(
scope: Construct,
id: String,
) {
private val cdkBuilder: CfnDeployment.Builder = CfnDeployment.Builder.create(scope, id)
/**
* The API identifier.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid)
* @param apiId The API identifier.
*/
public fun apiId(apiId: String) {
cdkBuilder.apiId(apiId)
}
/**
* The description for the deployment resource.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description)
* @param description The description for the deployment resource.
*/
public fun description(description: String) {
cdkBuilder.description(description)
}
/**
* The name of an existing stage to associate with the deployment.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename)
* @param stageName The name of an existing stage to associate with the deployment.
*/
public fun stageName(stageName: String) {
cdkBuilder.stageName(stageName)
}
public fun build(): CfnDeployment = cdkBuilder.build()
}