Package software.amazon.awscdk.services.cloudformation

Class CfnResourceDefaultVersion

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.cloudformation.CfnResourceDefaultVersion

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.679Z")
@Stability(Stable)
public class CfnResourceDefaultVersion
extends CfnResource
implements IInspectable

Specifies the default version of a resource.

The default version of a resource will be used in CloudFormation operations.

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.cloudformation.*;
 CfnResourceDefaultVersion cfnResourceDefaultVersion = CfnResourceDefaultVersion.Builder.create(this, "MyCfnResourceDefaultVersion")
         .typeName("typeName")
         .typeVersionArn("typeVersionArn")
         .versionId("versionId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html

Nested Class Summary

Nested Classes

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

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	CfnResourceDefaultVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourceDefaultVersion(software.amazon.jsii.JsiiObjectRef objRef)
	CfnResourceDefaultVersion(software.constructs.Construct scope, String id)
	CfnResourceDefaultVersion(software.constructs.Construct scope, String id, CfnResourceDefaultVersionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the resource.
protected Map<String,Object>	getCfnProperties()
String	getTypeName()	The name of the resource.
String	getTypeVersionArn()	The Amazon Resource Name (ARN) of the resource version.
String	getVersionId()	The ID of a specific version of the resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setTypeName(String value)	The name of the resource.
void	setTypeVersionArn(String value)	The Amazon Resource Name (ARN) of the resource version.
void	setVersionId(String value)	The ID of a specific version of the resource.

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

CfnResourceDefaultVersion

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

CfnResourceDefaultVersion

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

CfnResourceDefaultVersion

@Stability(Stable)
public CfnResourceDefaultVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnResourceDefaultVersionProps 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.

CfnResourceDefaultVersion

@Stability(Stable)
public CfnResourceDefaultVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

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.

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.

getAttrArn

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

The Amazon Resource Name (ARN) of the resource.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTypeName

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

The name of the resource.

setTypeName

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

The name of the resource.

getTypeVersionArn

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

The Amazon Resource Name (ARN) of the resource version.

setTypeVersionArn

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

The Amazon Resource Name (ARN) of the resource version.

getVersionId

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

The ID of a specific version of the resource.

setVersionId

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

The ID of a specific version of the resource.