View a markdown version of this page

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

Resource Type definition for AWS::CloudWatch::Space. A space is where you work in CloudWatch Omni. It gives you access to telemetry from the account and Region in which the space is hosted, and controls who can see it.

Syntax

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

JSON

{ "Type" : "AWS::CloudWatch::Space", "Properties" : { "AgentCoreEvaluationRoleArn" : String, "DataAccessRoleArn" : String, "DomainId" : String, "EncryptionConfiguration" : EncryptionConfiguration, "Name" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::CloudWatch::Space Properties: AgentCoreEvaluationRoleArn: String DataAccessRoleArn: String DomainId: String EncryptionConfiguration: EncryptionConfiguration Name: String Tags: - Tag

Properties

AgentCoreEvaluationRoleArn

The ARN of the IAM role used by AgentCore online evaluation. Absent when the space was created without one.

Required: No

Type: String

Pattern: ^arn:.+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

DataAccessRoleArn

The ARN of the IAM role used for data access.

Required: Yes

Type: String

Pattern: ^arn:.+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

DomainId

The ID of the domain to create the space in.

Required: Yes

Type: String

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

Update requires: Replacement

EncryptionConfiguration

How the space's data at rest is encrypted. Always populated.

Required: No

Type: EncryptionConfiguration

Update requires: No interruption

Name

A name that identifies the space.

Required: Yes

Type: String

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

Minimum: 3

Maximum: 64

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

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 space.

CreatedAt

The timestamp when the space was created.

OwnerAccountId

AWS account ID that owns this space.

Region

The region where this space was created.

SpaceId

The unique ID of the space.

Status

The status of the space.

UpdatedAt

The timestamp when the space was last updated.