Class CfnApplication
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.servicecatalogappregistry.CfnApplication
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggable,IApplicationRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-04T09:27:50.484Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, IApplicationRef, ITaggable
Represents a AWS Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.
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.servicecatalogappregistry.*;
CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
.name("name")
// the properties below are optional
.description("description")
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalogappregistry.IApplicationRef
IApplicationRef.Jsii$Default, IApplicationRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnApplication(software.amazon.jsii.JsiiObjectRef objRef) CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IApplicationReffromApplicationArn(software.constructs.Construct scope, String id, String arn) Creates a new IApplicationRef from an ARN.static IApplicationReffromApplicationId(software.constructs.Construct scope, String id, String applicationId) Creates a new IApplicationRef from a applicationId.A reference to a Application resource.The name of the application.The key of the AWS application tag, which isawsApplication.The value of the AWS application tag, which is the identifier of an associated resource.The Amazon resource name (ARN) that specifies the application across services.The identifier of the application.The description of the application.getName()The name of the application.getTags()Tag Manager which manages the tags for this resource.Key-value pairs you can use to associate with the application.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetDescription(String value) The description of the application.voidThe name of the application.voidsetTagsRaw(Map<String, String> value) Key-value pairs you can use to associate with the application.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods 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
-
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef) -
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnApplication
@Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps 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
-
fromApplicationArn
@Stability(Stable) @NotNull public static IApplicationRef fromApplicationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn) Creates a new IApplicationRef from an ARN.- Parameters:
scope- This parameter is required.id- This parameter is required.arn- This parameter is required.
-
fromApplicationId
@Stability(Stable) @NotNull public static IApplicationRef fromApplicationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationId) Creates a new IApplicationRef from a applicationId.- Parameters:
scope- This parameter is required.id- This parameter is required.applicationId- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getApplicationRef
A reference to a Application resource.- Specified by:
getApplicationRefin interfaceIApplicationRef
-
getAttrApplicationName
The name of the application.The name must be unique in the region in which you are creating the application.
-
getAttrApplicationTagKey
The key of the AWS application tag, which isawsApplication.Applications created before 11/13/2023 or applications without the
AppTaglinked resource group return no value. -
getAttrApplicationTagValue
The value of the AWS application tag, which is the identifier of an associated resource.Applications created before 11/13/2023 or applications without the
AppTaglinked resource group return no value. -
getAttrArn
The Amazon resource name (ARN) that specifies the application across services. -
getAttrId
The identifier of the application. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the application. -
setName
The name of the application. -
getDescription
The description of the application. -
setDescription
The description of the application. -
getTagsRaw
Key-value pairs you can use to associate with the application. -
setTagsRaw
Key-value pairs you can use to associate with the application.
-