View a markdown version of this page

AWS::AccountAccess::Entitlement - AWS CloudFormation
SyntaxPropertiesReturn values

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::AccountAccess::Entitlement

Specifies the entitlement configuration, including the principal and the IAM role to grant access to.

Syntax

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

JSON

{
  "Type" : "AWS::AccountAccess::Entitlement",
  "Properties" : {
      "ApplicationArn" : String,
      "Entitlement" : Entitlement
    }
}

YAML

Type: AWS::AccountAccess::Entitlement
Properties:
  ApplicationArn: String
  Entitlement: 
    Entitlement

Properties

ApplicationArn

Specifies the ARN of the application to create the entitlement for.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-]+:account-access:[a-z0-9]+(-[a-z0-9]+)*:[0-9]{12}:application/[a-zA-Z0-9-]+$

Update requires: Replacement

Entitlement

Specifies the entitlement configuration, including the principal and the IAM role to grant access to.

Required: Yes

Type: Entitlement

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier of the entitlement.

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.

CreatedAt

The date and time when the entitlement was created.

Entitlement.PrincipalRole.Account

The 12-digit AWS account ID where the IAM role resides.

EntitlementId

The unique identifier of the entitlement.