software.amazon.awscdk.services.m2

Class CfnApplication

java.lang.Object

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.m2.CfnApplication

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.464Z")
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::M2::Application`.

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")
         .definition(DefinitionProperty.builder()
                 .content("content")
                 .s3Location("s3Location")
                 .build())
         .engineType("engineType")
         .name("name")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplication.Builder A fluent builder for CfnApplication.
static interface	CfnApplication.DefinitionProperty The application definition for a particular application.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props) Create a new `AWS::M2::Application`.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrApplicationArn() The Amazon Resource Name (ARN) of the application.
java.lang.String	getAttrApplicationId() The identifier of the application.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDefinition() The application definition for a particular application.
java.lang.String	getDescription() The description of the application.
java.lang.String	getEngineType() The type of the target platform for this application.
java.lang.String	getKmsKeyId() The identifier of a customer managed key.
java.lang.String	getName() The name of the application.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDefinition(CfnApplication.DefinitionProperty value) The application definition for a particular application.
void	setDefinition(IResolvable value) The application definition for a particular application.
void	setDescription(java.lang.String value) The description of the application.
void	setEngineType(java.lang.String value) The type of the target platform for this application.
void	setKmsKeyId(java.lang.String value) The identifier of a customer managed key.
void	setName(java.lang.String value) The name of the application.

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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplication

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

CfnApplication

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

CfnApplication

public CfnApplication(Construct scope,
                      java.lang.String id,
                      CfnApplicationProps props)

Create a new `AWS::M2::Application`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApplicationArn

public java.lang.String getAttrApplicationArn()

The Amazon Resource Name (ARN) of the application.

getAttrApplicationId

public java.lang.String getAttrApplicationId()

The identifier of the application.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getDefinition

public java.lang.Object getDefinition()

The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location.

For information about application definitions, see the AWS Mainframe Modernization User Guide .

setDefinition

public void setDefinition(CfnApplication.DefinitionProperty value)

The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location.

For information about application definitions, see the AWS Mainframe Modernization User Guide .

setDefinition

public void setDefinition(IResolvable value)

The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location.

For information about application definitions, see the AWS Mainframe Modernization User Guide .

getEngineType

public java.lang.String getEngineType()

The type of the target platform for this application.

setEngineType

public void setEngineType(java.lang.String value)

The type of the target platform for this application.

getName

public java.lang.String getName()

The name of the application.

setName

public void setName(java.lang.String value)

The name of the application.

getDescription

public java.lang.String getDescription()

The description of the application.

setDescription

public void setDescription(java.lang.String value)

The description of the application.

getKmsKeyId

public java.lang.String getKmsKeyId()

The identifier of a customer managed key.

setKmsKeyId

public void setKmsKeyId(java.lang.String value)

The identifier of a customer managed key.