Package software.amazon.awscdk.services.apigatewayv2

Class CfnDeployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnDeployment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:05.929Z")
@Stability(Stable)
public class CfnDeployment
extends CfnResource
implements IInspectable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDeployment.Builder	A fluent builder for CfnDeployment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDeployment(software.constructs.Construct scope, String id, CfnDeploymentProps props)

Method Summary

Modifier and Type	Method	Description
String	getApiId()	The API identifier.
String	getAttrDeploymentId()	The deployment ID.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description for the deployment resource.
String	getStageName()	The name of an existing stage to associate with the deployment.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value)	The API identifier.
void	setDescription(String value)	The description for the deployment resource.
void	setStageName(String value)	The name of an existing stage to associate with the deployment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeployment

@Stability(Stable)
public CfnDeployment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDeploymentProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDeploymentId

@Stability(Stable)
@NotNull
public String getAttrDeploymentId()

The deployment ID.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(Stable)
@NotNull
public String getApiId()

The API identifier.

setApiId

@Stability(Stable)
public void setApiId(@NotNull
 String value)

The API identifier.

getDescription

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

The description for the deployment resource.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description for the deployment resource.

getStageName

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

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

setStageName

@Stability(Stable)
public void setStageName(@Nullable
 String value)

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