AWS::SecurityAgent::Application - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SecurityAgent::Application

The AWS::SecurityAgent::Application resource specifies a Security Agent application. An application provides the top-level configuration for Security Agent, including identity and access management settings and encryption options.

Syntax

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

JSON

{
  "Type" : "AWS::SecurityAgent::Application",
  "Properties" : {
      "DefaultKmsKeyId" : String,
      "IdCConfiguration" : IdCConfiguration,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SecurityAgent::Application
Properties:
  DefaultKmsKeyId: String
  IdCConfiguration: 
    IdCConfiguration
  RoleArn: String
  Tags: 
    - Tag

Properties

DefaultKmsKeyId

The identifier of the default Amazon Web Services KMS key to use for encrypting data in the application.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: No interruption

IdCConfiguration

The IAM Identity Center configuration for the application.

Required: No

Type: IdCConfiguration

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the IAM role to associate with the application.

Required: No

Type: String

Update requires: No interruption

Tags

The tags to associate with the application.

Required: No

Type: Array of Tag

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 ID. For example:

{ "Ref": "MyApplication" }

For the application MyApplication, Ref returns the unique identifier of the Security Agent application.

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.

ApplicationId

The unique identifier of the Security Agent application. For example: app-0123456789abcdef0.

ApplicationName

The name of the Security Agent application.

Domain

The domain associated with the Security Agent application.

IdCConfiguration.IdCApplicationArn

The Amazon Resource Name (ARN) of the IAM Identity Center application associated with the Security Agent application.