Package software.amazon.awscdk.services.apigatewayv2

Interface CfnDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.735Z")
@Stability(Stable)
public interface CfnDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeployment.

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.*;
 CfnDeploymentProps cfnDeploymentProps = CfnDeploymentProps.builder()
         .apiId("apiId")
         // the properties below are optional
         .description("description")
         .stageName("stageName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentProps.Builder	A builder for CfnDeploymentProps
static final class	CfnDeploymentProps.Jsii$Proxy	An implementation for CfnDeploymentProps

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentProps.Builder	builder()
String	getApiId()	The API identifier.
default String	getDescription()	The description for the deployment resource.
default String	getStageName()	The name of an existing stage to associate with the deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for the deployment resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

The name of an existing stage to associate with the deployment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename

builder

@Stability(Stable)
static CfnDeploymentProps.Builder builder()

Returns:

a CfnDeploymentProps.Builder of CfnDeploymentProps