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

Resource Type definition for AWS::CloudWatch::DomainForOrganization. The organization-level boundary for CloudWatch Omni: an organization domain configures the identity providers users sign in through for the whole AWS Organization and exposes the endpoint URLs used to reach CloudWatch Omni. It can only be created by the organization's management account.

Syntax

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

JSON

{
  "Type" : "AWS::CloudWatch::DomainForOrganization",
  "Properties" : {
      "DomainAccessRoleArn" : String,
      "IdentityProviderConfiguration" : IdentityProviderConfiguration,
      "IdentityProviders" : [ String, ... ],
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CloudWatch::DomainForOrganization
Properties:
  DomainAccessRoleArn: String
  IdentityProviderConfiguration: 
    IdentityProviderConfiguration
  IdentityProviders: 
    - String
  Name: String
  Tags: 
    - Tag

Properties

DomainAccessRoleArn

The ARN of an IAM role in the management account that CloudWatch Omni assumes for domain-scoped credential vending.

Required: Yes

Type: String

Pattern: ^arn:aws[a-zA-Z-]*:iam::[0-9]{12}:role/.+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

IdentityProviderConfiguration

Identity provider configuration for the domain.

Required: No

Type: IdentityProviderConfiguration

Update requires: No interruption

IdentityProviders

The identity providers configured for the domain.

Required: Yes

Type: Array of String

Allowed values: IAM | IDC

Minimum: 1

Maximum: 2

Update requires: No interruption

Name

A name that identifies the domain.

Required: Yes

Type: String

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

Minimum: 3

Maximum: 63

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

CreatedAt

The timestamp when the domain was created.

CustomEndpointUrls

Additional endpoint URLs derived from the domain name.

DomainEndpointUrl

The HTTPS endpoint URL for accessing the domain.

DomainId

The unique ID of the domain.

IdentityCenterApplicationArn

The ARN of the Identity Center application. Absent for IAM-only domains.

OrganizationId

The ID of the AWS Organization this domain belongs to.

OwnerAccountId

The account ID of the organization's management account, which owns this domain.

Region

The Region where this domain was created.

Status

Current status of the domain.

UpdatedAt

The timestamp when the domain was last updated.