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.m2.CfnApplication
- All Implemented Interfaces:
IInspectable,ITaggable,IApplicationRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-10-14T12:28:15.385Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, IApplicationRef, ITaggable
Specifies a new application with given parameters. Requires an existing runtime environment and application definition file.
For information about application definitions, see the AWS Mainframe Modernization User Guide .
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.m2.*;
CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
.engineType("engineType")
.name("name")
// the properties below are optional
.definition(DefinitionProperty.builder()
.content("content")
.s3Location("s3Location")
.build())
.description("description")
.kmsKeyId("kmsKeyId")
.roleArn("roleArn")
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnApplication.static interfaceThe application definition for a particular application.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.m2.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 TypeMethodDescriptionA reference to a Application resource.The Amazon Resource Name (ARN) of the application.The identifier of the application.The application definition for a particular application.The description of the application.The type of the target platform for this application.The identifier of a customer managed key.getName()The name of the application.The Amazon Resource Name (ARN) of the role associated with the application.getTags()Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetDefinition(IResolvable value) The application definition for a particular application.voidThe application definition for a particular application.voidsetDescription(String value) The description of the application.voidsetEngineType(String value) The type of the target platform for this application.voidsetKmsKeyId(String value) The identifier of a customer managed key.voidThe name of the application.voidsetRoleArn(String value) The Amazon Resource Name (ARN) of the role associated with the application.voidsetTagsRaw(Map<String, String> value) An array of key-value pairs to apply to this 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, 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.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
-
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
-
getAttrApplicationArn
The Amazon Resource Name (ARN) of the application. -
getAttrApplicationId
The identifier of the application. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getEngineType
The type of the target platform for this application. -
setEngineType
The type of the target platform for this application. -
getName
The name of the application. -
setName
The name of the application. -
getDefinition
The application definition for a particular application.You can specify either inline JSON or an Amazon S3 bucket location.
-
setDefinition
The application definition for a particular application.You can specify either inline JSON or an Amazon S3 bucket location.
-
setDefinition
The application definition for a particular application.You can specify either inline JSON or an Amazon S3 bucket location.
-
getDescription
The description of the application. -
setDescription
The description of the application. -
getKmsKeyId
The identifier of a customer managed key. -
setKmsKeyId
The identifier of a customer managed key. -
getRoleArn
The Amazon Resource Name (ARN) of the role associated with the application. -
setRoleArn
The Amazon Resource Name (ARN) of the role associated with the application. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-