Class CfnDeployment
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnDeployment
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.179Z")
@Stability(Stable)
public class CfnDeployment
extends CfnResource
implements IInspectable
A CloudFormation
AWS::ApiGatewayV2::Deployment
.
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDeployment
(Construct scope, String id, CfnDeploymentProps props) Create a newAWS::ApiGatewayV2::Deployment
.protected
CfnDeployment
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDeployment
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptiongetApiId()
The API identifier.The deployment ID.The description for the deployment resource.The name of an existing stage to associate with the deployment.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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
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 Construct scope, @NotNull String id, @NotNull CfnDeploymentProps props) Create a newAWS::ApiGatewayV2::Deployment
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrDeploymentId
The deployment ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApiId
The API identifier. -
setApiId
The API identifier. -
getDescription
The description for the deployment resource. -
setDescription
The description for the deployment resource. -
getStageName
The name of an existing stage to associate with the deployment. -
setStageName
The name of an existing stage to associate with the deployment.
-