1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudwatch
  6. Domain

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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:

    IdentityProviders List<Pulumi.AwsNative.CloudWatch.DomainIdentityProvidersItem>
    The identity providers configured for the domain.
    IdentityProviderConfiguration Pulumi.AwsNative.CloudWatch.Inputs.DomainIdentityProviderConfiguration
    Identity provider configuration for the domain.
    Name string
    A name that identifies the domain.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    IdentityProviders []DomainIdentityProvidersItem
    The identity providers configured for the domain.
    IdentityProviderConfiguration DomainIdentityProviderConfigurationArgs
    Identity provider configuration for the domain.
    Name string
    A name that identifies the domain.
    Tags TagArgs
    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_configuration object
    Identity provider configuration for the domain.
    name string
    A name that identifies the domain.
    tags list(object)
    An array of key-value pairs to apply to this resource.
    identityProviders List<DomainIdentityProvidersItem>
    The identity providers configured for the domain.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration for the domain.
    name String
    A name that identifies the domain.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    identityProviders DomainIdentityProvidersItem[]
    The identity providers configured for the domain.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration for the domain.
    name string
    A name that identifies the domain.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    identity_providers Sequence[DomainIdentityProvidersItem]
    The identity providers configured for the domain.
    identity_provider_configuration DomainIdentityProviderConfigurationArgs
    Identity provider configuration for the domain.
    name str
    A name that identifies the domain.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    identityProviders List<"IAM" | "IDC">
    The identity providers configured for the domain.
    identityProviderConfiguration Property Map
    Identity provider configuration for the domain.
    name String
    A name that identifies the domain.
    tags 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.
    CreatedAt string
    The timestamp when the domain was created.
    CustomEndpointUrls List<string>
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    The HTTPS endpoint URL for accessing the domain.
    DomainId string
    The unique ID of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The ARN of the Identity Center application. Absent for IAM-only domains.
    Region string
    The Region where this domain was created.
    Status Pulumi.AwsNative.CloudWatch.DomainStatus
    Current status of the domain.
    UpdatedAt string
    The timestamp when the domain was last updated.
    Arn string
    The Amazon Resource Name (ARN) of the domain.
    CreatedAt string
    The timestamp when the domain was created.
    CustomEndpointUrls []string
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    The HTTPS endpoint URL for accessing the domain.
    DomainId string
    The unique ID of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The ARN of the Identity Center application. Absent for IAM-only domains.
    Region string
    The Region where this domain was created.
    Status DomainStatus
    Current status of the domain.
    UpdatedAt 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_urls list(string)
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url string
    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_application_arn string
    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.
    createdAt String
    The timestamp when the domain was created.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    The HTTPS endpoint URL for accessing the domain.
    domainId String
    The unique ID of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    The ARN of the Identity Center application. Absent for IAM-only domains.
    region String
    The Region where this domain was created.
    status DomainStatus
    Current status of the domain.
    updatedAt String
    The timestamp when the domain was last updated.
    arn string
    The Amazon Resource Name (ARN) of the domain.
    createdAt string
    The timestamp when the domain was created.
    customEndpointUrls string[]
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl string
    The HTTPS endpoint URL for accessing the domain.
    domainId string
    The unique ID of the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn string
    The ARN of the Identity Center application. Absent for IAM-only domains.
    region string
    The Region where this domain was created.
    status DomainStatus
    Current status of the domain.
    updatedAt 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_urls Sequence[str]
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url str
    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_application_arn str
    The ARN of the Identity Center application. Absent for IAM-only domains.
    region str
    The Region where this domain was created.
    status DomainStatus
    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.
    createdAt String
    The timestamp when the domain was created.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    The HTTPS endpoint URL for accessing the domain.
    domainId String
    The unique ID of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    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.
    updatedAt 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) -> Domain
    func 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.

    IdentityCenterInstanceArn string
    Identity Center instance ARN
    IdentityCenterInstanceArn string
    Identity Center instance ARN
    identity_center_instance_arn string
    Identity Center instance ARN
    identityCenterInstanceArn String
    Identity Center instance ARN
    identityCenterInstanceArn string
    Identity Center instance ARN
    identity_center_instance_arn str
    Identity Center instance ARN
    identityCenterInstanceArn String
    Identity Center instance ARN

    DomainIdentityProviderConfiguration, DomainIdentityProviderConfigurationArgs

    Identity provider configuration for the domain.

    DomainIdentityProvidersItem

    NameValue
    IamIAM
    IdcIDC
    NameValue
    DomainIdentityProvidersItemIamIAM
    DomainIdentityProvidersItemIdcIDC
    Value
    IAM
    IDC
    NameValue
    IamIAM
    IdcIDC
    NameValue
    IamIAM
    IdcIDC
    NameValue
    IAMIAM
    IDCIDC
    Value
    IAM
    IDC

    DomainStatus

    Current status of the domain.

    NameValue
    ActiveACTIVE
    NameValue
    DomainStatusActiveACTIVE
    Value
    ACTIVE
    NameValue
    ActiveACTIVE
    NameValue
    ActiveACTIVE
    NameValue
    ACTIVEACTIVE
    Value
    ACTIVE

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial