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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::M2::Application",
  "Properties" : {
      "Definition" : Definition,
      "Description" : String,
      "EngineType" : String,
      "KmsKeyId" : String,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::M2::Application
Properties:
  Definition: 
    Definition
  Description: String
  EngineType: String
  KmsKeyId: String
  Name: String
  RoleArn: String
  Tags: 
    Key: Value

Properties

Definition

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.

Required: No

Type: Definition

Update requires: No interruption

Description

The description of the application.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: No interruption

EngineType

The type of the target platform for this application.

Required: Yes

Type: String

Allowed values: microfocus | bluage

Update requires: Replacement

KmsKeyId

The identifier of a customer managed key.

Required: No

Type: String

Maximum: 2048

Update requires: Replacement

Name

The name of the application.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the role associated with the application.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Object of String

Pattern: ^(?!aws:).+$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application Amazon Resource Name (ARN), such as the following:

{ "Ref": “SampleApp” }

Returns a value similar to the following:

arn:aws:m2:us-west-2:1234567890:app/y3ca6bhaife2bcvxar3lpivfou

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ApplicationArn

The Amazon Resource Name (ARN) of the application.

ApplicationId

The identifier of the application.