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

Resource Type definition for AWS::CloudWatch::DomainAccessGrantForOrganization. An organization access grant authorizes a principal to administer an organization-scoped CloudWatch Omni domain.

Syntax

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

JSON

{
  "Type" : "AWS::CloudWatch::DomainAccessGrantForOrganization",
  "Properties" : {
      "DomainId" : String,
      "Name" : String,
      "Permission" : String,
      "Principal" : OrganizationAccessGrantPrincipal,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CloudWatch::DomainAccessGrantForOrganization
Properties:
  DomainId: String
  Name: String
  Permission: String
  Principal: 
    OrganizationAccessGrantPrincipal
  Tags: 
    - Tag

Properties

DomainId

The unique identifier of the organization domain the grant applies to.

Required: Yes

Type: String

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

Update requires: Replacement

Name

The name of the grant.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

Permission

The permission level the grant confers. Organization grants are administrative only.

Required: Yes

Type: String

Allowed values: ADMIN

Update requires: Replacement

Principal

The principal the grant is issued to.

Required: Yes

Type: OrganizationAccessGrantPrincipal

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.

Arn

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

CreatedAt

The time the grant was created.

CreatedBy

The principal that created the grant.

GrantId

The unique identifier of the grant.

GrantType

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

UpdatedAt

The time the grant was last updated.