View a markdown version of this page

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

Resource Type definition for AWS::CloudWatch::DomainForOrganization. An organization domain provides a single sign-in URL and centralized identity provider configuration for your AWS Organization, removing the need for each account to configure its own domain. Only the management account can create it.

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 the customer-provided IAM role in the management account used for domain access.

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 organization domain.

Required: No

Type: IdentityProviderConfiguration

Update requires: No interruption

IdentityProviders

The identity providers configured for the organization 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 organization 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 organization domain.

CreatedAt

The timestamp when the organization domain was created.

CustomEndpointUrls

Additional endpoint URLs derived from the domain name.

DomainEndpointUrl

The HTTPS endpoint URL for accessing the organization domain.

DomainId

The unique ID of the organization domain.

IdentityCenterApplicationArn

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

OrganizationId

The ID of the AWS Organization that owns the domain.

OwnerAccountId

The AWS account ID that owns the organization domain.

Region

The Region where this organization domain was created.

Status

Current status of the organization domain.

UpdatedAt

The timestamp when the organization domain was last updated.