We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::CloudWatch::Domain. A domain is the identity and access boundary for CloudWatch Omni. It configures the identity providers users sign in through and provides the sign-in URL for your team.
Create Domain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);@overload
def Domain(resource_name: str,
args: DomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
identity_providers: Optional[Sequence[DomainIdentityProvidersItem]] = None,
identity_provider_configuration: Optional[DomainIdentityProviderConfigurationArgs] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_cloudwatch_domain" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Domain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Domain resource accepts the following input properties:
- Identity
Providers List<Pulumi.Aws Native. Cloud Watch. Domain Identity Providers Item> - The identity providers configured for the domain.
- Identity
Provider Pulumi.Configuration Aws Native. Cloud Watch. Inputs. Domain Identity Provider Configuration - Identity provider configuration for the domain.
- Name string
- A name that identifies the domain.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Identity
Providers []DomainIdentity Providers Item - The identity providers configured for the domain.
- Identity
Provider DomainConfiguration Identity Provider Configuration Args - Identity provider configuration for the domain.
- Name string
- A name that identifies the domain.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- identity_
providers list("IAM" | "IDC") - The identity providers configured for the domain.
- identity_
provider_ objectconfiguration - Identity provider configuration for the domain.
- name string
- A name that identifies the domain.
- list(object)
- An array of key-value pairs to apply to this resource.
- identity
Providers List<DomainIdentity Providers Item> - The identity providers configured for the domain.
- identity
Provider DomainConfiguration Identity Provider Configuration - Identity provider configuration for the domain.
- name String
- A name that identifies the domain.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- identity
Providers DomainIdentity Providers Item[] - The identity providers configured for the domain.
- identity
Provider DomainConfiguration Identity Provider Configuration - Identity provider configuration for the domain.
- name string
- A name that identifies the domain.
- Tag[]
- An array of key-value pairs to apply to this resource.
- identity_
providers Sequence[DomainIdentity Providers Item] - The identity providers configured for the domain.
- identity_
provider_ Domainconfiguration Identity Provider Configuration Args - Identity provider configuration for the domain.
- name str
- A name that identifies the domain.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- identity
Providers List<"IAM" | "IDC"> - The identity providers configured for the domain.
- identity
Provider Property MapConfiguration - Identity provider configuration for the domain.
- name String
- A name that identifies the domain.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the domain.
- Created
At string - The timestamp when the domain was created.
- Custom
Endpoint List<string>Urls - Additional endpoint URLs derived from the domain name.
- Domain
Endpoint stringUrl - The HTTPS endpoint URL for accessing the domain.
- Domain
Id string - The unique ID of the domain.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Center stringApplication Arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- Region string
- The Region where this domain was created.
- Status
Pulumi.
Aws Native. Cloud Watch. Domain Status - Current status of the domain.
- Updated
At string - The timestamp when the domain was last updated.
- Arn string
- The Amazon Resource Name (ARN) of the domain.
- Created
At string - The timestamp when the domain was created.
- Custom
Endpoint []stringUrls - Additional endpoint URLs derived from the domain name.
- Domain
Endpoint stringUrl - The HTTPS endpoint URL for accessing the domain.
- Domain
Id string - The unique ID of the domain.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Center stringApplication Arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- Region string
- The Region where this domain was created.
- Status
Domain
Status - Current status of the domain.
- Updated
At string - The timestamp when the domain was last updated.
- arn string
- The Amazon Resource Name (ARN) of the domain.
- created_
at string - The timestamp when the domain was created.
- custom_
endpoint_ list(string)urls - Additional endpoint URLs derived from the domain name.
- domain_
endpoint_ stringurl - The HTTPS endpoint URL for accessing the domain.
- domain_
id string - The unique ID of the domain.
- id string
- The provider-assigned unique ID for this managed resource.
- identity_
center_ stringapplication_ arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- region string
- The Region where this domain was created.
- status "ACTIVE"
- Current status of the domain.
- updated_
at string - The timestamp when the domain was last updated.
- arn String
- The Amazon Resource Name (ARN) of the domain.
- created
At String - The timestamp when the domain was created.
- custom
Endpoint List<String>Urls - Additional endpoint URLs derived from the domain name.
- domain
Endpoint StringUrl - The HTTPS endpoint URL for accessing the domain.
- domain
Id String - The unique ID of the domain.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Center StringApplication Arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- region String
- The Region where this domain was created.
- status
Domain
Status - Current status of the domain.
- updated
At String - The timestamp when the domain was last updated.
- arn string
- The Amazon Resource Name (ARN) of the domain.
- created
At string - The timestamp when the domain was created.
- custom
Endpoint string[]Urls - Additional endpoint URLs derived from the domain name.
- domain
Endpoint stringUrl - The HTTPS endpoint URL for accessing the domain.
- domain
Id string - The unique ID of the domain.
- id string
- The provider-assigned unique ID for this managed resource.
- identity
Center stringApplication Arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- region string
- The Region where this domain was created.
- status
Domain
Status - Current status of the domain.
- updated
At string - The timestamp when the domain was last updated.
- arn str
- The Amazon Resource Name (ARN) of the domain.
- created_
at str - The timestamp when the domain was created.
- custom_
endpoint_ Sequence[str]urls - Additional endpoint URLs derived from the domain name.
- domain_
endpoint_ strurl - The HTTPS endpoint URL for accessing the domain.
- domain_
id str - The unique ID of the domain.
- id str
- The provider-assigned unique ID for this managed resource.
- identity_
center_ strapplication_ arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- region str
- The Region where this domain was created.
- status
Domain
Status - Current status of the domain.
- updated_
at str - The timestamp when the domain was last updated.
- arn String
- The Amazon Resource Name (ARN) of the domain.
- created
At String - The timestamp when the domain was created.
- custom
Endpoint List<String>Urls - Additional endpoint URLs derived from the domain name.
- domain
Endpoint StringUrl - The HTTPS endpoint URL for accessing the domain.
- domain
Id String - The unique ID of the domain.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Center StringApplication Arn - The ARN of the Identity Center application. Absent for IAM-only domains.
- region String
- The Region where this domain was created.
- status "ACTIVE"
- Current status of the domain.
- updated
At String - The timestamp when the domain was last updated.
Look up Existing Domain Resource
Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Domain@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Domainfunc GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)public static Domain Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Domain get(String name, Output<String> id, CustomResourceOptions options)resources: existingDomain: type: aws-native:cloudwatch:Domain get: id: ${id}import {
to = aws-native_cloudwatch_domain.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state DomainState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
DomainIdentityCenterConfiguration, DomainIdentityCenterConfigurationArgs
Identity Center configuration. Required when identityProviders includes IDC.
- Identity
Center stringInstance Arn - Identity Center instance ARN
- Identity
Center stringInstance Arn - Identity Center instance ARN
- identity_
center_ stringinstance_ arn - Identity Center instance ARN
- identity
Center StringInstance Arn - Identity Center instance ARN
- identity
Center stringInstance Arn - Identity Center instance ARN
- identity_
center_ strinstance_ arn - Identity Center instance ARN
- identity
Center StringInstance Arn - Identity Center instance ARN
DomainIdentityProviderConfiguration, DomainIdentityProviderConfigurationArgs
Identity provider configuration for the domain.
DomainIdentityProvidersItem
| Name | Value |
|---|---|
| Iam | IAM |
| Idc | IDC |
| Name | Value |
|---|---|
| Domain | IAM |
| Domain | IDC |
| Value |
|---|
IAM |
IDC |
| Name | Value |
|---|---|
| Iam | IAM |
| Idc | IDC |
| Name | Value |
|---|---|
| Iam | IAM |
| Idc | IDC |
| Name | Value |
|---|---|
| IAM | IAM |
| IDC | IDC |
| Value |
|---|
IAM |
IDC |
DomainStatus
Current status of the domain.
| Name | Value |
|---|---|
| Active | ACTIVE |
| Name | Value |
|---|---|
| Domain | ACTIVE |
| Value |
|---|
ACTIVE |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Name | Value |
|---|---|
| ACTIVE | ACTIVE |
| Value |
|---|
ACTIVE |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi