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

Resource type definition for AWS::CloudWatch::AccessGrant

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 unique identifier of the domain that contains the space.

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. Exactly one permission is granted per access grant.

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 to allow, each with the resource scopes and conditions that limit those actions.

Required: No

Type: Array of ScopedActions

Maximum: 20

Update requires: Replacement

SpaceId

The unique identifier of the space the access grant is scoped to.

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 access grant.

Arn

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

CreatedAt

The time the access grant was created.

CreatedBy

The principal that created the access grant.

GrantId

The unique identifier of the access grant.

GrantType

Whether the access grant is managed by the service or by the customer.

UpdatedAt

The time the access grant was last updated.