Package software.amazon.awscdk.services.m2

Class CfnApplication

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.m2.CfnApplication
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:29:59.835Z") @Stability(Stable) 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")
         .roleArn("roleArn")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • 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

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull Construct scope, @NotNull String id, @NotNull 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 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.

    • getAttrApplicationArn

      @Stability(Stable) @NotNull public String getAttrApplicationArn()
      The Amazon Resource Name (ARN) of the application.

    • getAttrApplicationId

      @Stability(Stable) @NotNull public String getAttrApplicationId()
      The identifier of the application.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getDefinition

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setDefinition(@NotNull 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

      @Stability(Stable) public void setDefinition(@NotNull 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

      @Stability(Stable) @NotNull public String getEngineType()
      The type of the target platform for this application.

    • setEngineType

      @Stability(Stable) public void setEngineType(@NotNull String value)
      The type of the target platform for this application.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the application.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the application.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the application.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The identifier of a customer managed key.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The identifier of a customer managed key.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      AWS::M2::Application.RoleArn.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      AWS::M2::Application.RoleArn.