View a markdown version of this page

AWS::CloudWatch::AccessGrant - AWS CloudFormation

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::CloudWatch::AccessGrant

Resource Type definition for AWS::CloudWatch::AccessGrant. An access grant authorizes a principal to perform a set of actions on resources in a space.

Syntax

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

JSON

{ "Type" : "AWS::CloudWatch::AccessGrant", "Properties" : { "DomainId" : String, "Name" : String, "Permission" : String, "Principal" : AccessGrantPrincipal, "ScopedActions" : [ ScopedActions, ... ], "SpaceId" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::CloudWatch::AccessGrant Properties: DomainId: String Name: String Permission: String Principal: AccessGrantPrincipal ScopedActions: - ScopedActions SpaceId: String Tags: - Tag

Properties

DomainId

The ID of the domain the grant belongs to.

Required: Yes

Type: String

Pattern: ^d-[0-9a-z]{1,25}$

Update requires: Replacement

Name

A name that identifies the access grant.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Permission

The permission granted.

Required: Yes

Type: String

Allowed values: SPACE_ADMIN | READ | READ_WRITE_DELETE | CUSTOM

Update requires: Replacement

Principal

The principal receiving the grant.

Required: Yes

Type: AccessGrantPrincipal

Update requires: Replacement

ScopedActions

Groups of actions allowed by the grant, each with the resource scopes and conditions that limit those actions.

Required: No

Type: Array of ScopedActions

Maximum: 20

Update requires: Replacement

SpaceId

The space this grant applies to. Domain-scoped grants are returned by ListDomainAccessGrantsForOrganization instead.

Required: Yes

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the value of the Arn property.

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.

AccountId

The AWS account ID that owns the grant.

Arn

The Amazon Resource Name (ARN) of the access grant.

CreatedAt

The timestamp when the grant was created.

CreatedBy

The principal that created the grant.

GrantId

The unique ID of the access grant.

GrantType

Who manages the grant.

UpdatedAt

The timestamp when the grant was last updated.