1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. cloudwatchomni
  6. Domain
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi

    Manages an Amazon CloudWatch Omni domain.

    A domain is the top-level container for CloudWatch Omni. It configures how users sign in and contains the spaces that hold telemetry. An account can have one domain.

    NOTE: A domain cannot be deleted while it contains spaces.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.cloudwatchomni.Domain("example", {
        name: "example",
        identityProviders: ["IAM"],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.cloudwatchomni.Domain("example",
        name="example",
        identity_providers=["IAM"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatchomni"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudwatchomni.NewDomain(ctx, "example", &cloudwatchomni.DomainArgs{
    			Name: pulumi.String("example"),
    			IdentityProviders: pulumi.StringArray{
    				pulumi.String("IAM"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.CloudWatchOmni.Domain("example", new()
        {
            Name = "example",
            IdentityProviders = new[]
            {
                "IAM",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cloudwatchomni.Domain;
    import com.pulumi.aws.cloudwatchomni.DomainArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Domain("example", DomainArgs.builder()
                .name("example")
                .identityProviders("IAM")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cloudwatchomni:Domain
        properties:
          name: example
          identityProviders:
            - IAM
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_cloudwatchomni_domain" "example" {
      name               = "example"
      identity_providers = ["IAM"]
    }
    

    With IAM Identity Center

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.ssoadmin.getInstances({});
    const exampleDomain = new aws.cloudwatchomni.Domain("example", {
        identityProviderConfiguration: {
            identityCenterConfiguration: {
                identityCenterInstanceArn: example.then(example => example.arns?.[0]),
            },
        },
        name: "example",
        identityProviders: [
            "IAM",
            "IDC",
        ],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ssoadmin.get_instances()
    example_domain = aws.cloudwatchomni.Domain("example",
        identity_provider_configuration={
            "identity_center_configuration": {
                "identity_center_instance_arn": example.arns[0],
            },
        },
        name="example",
        identity_providers=[
            "IAM",
            "IDC",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatchomni"
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssoadmin"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := ssoadmin.GetInstances(ctx, &ssoadmin.GetInstancesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = cloudwatchomni.NewDomain(ctx, "example", &cloudwatchomni.DomainArgs{
    			IdentityProviderConfiguration: &cloudwatchomni.DomainIdentityProviderConfigurationArgs{
    				IdentityCenterConfiguration: &cloudwatchomni.DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs{
    					IdentityCenterInstanceArn: pulumi.String(example.Arns[0]),
    				},
    			},
    			Name: pulumi.String("example"),
    			IdentityProviders: pulumi.StringArray{
    				pulumi.String("IAM"),
    				pulumi.String("IDC"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.SsoAdmin.GetInstances.Invoke();
    
        var exampleDomain = new Aws.CloudWatchOmni.Domain("example", new()
        {
            IdentityProviderConfiguration = new Aws.CloudWatchOmni.Inputs.DomainIdentityProviderConfigurationArgs
            {
                IdentityCenterConfiguration = new Aws.CloudWatchOmni.Inputs.DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs
                {
                    IdentityCenterInstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
                },
            },
            Name = "example",
            IdentityProviders = new[]
            {
                "IAM",
                "IDC",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ssoadmin.SsoadminFunctions;
    import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
    import com.pulumi.aws.cloudwatchomni.Domain;
    import com.pulumi.aws.cloudwatchomni.DomainArgs;
    import com.pulumi.aws.cloudwatchomni.inputs.DomainIdentityProviderConfigurationArgs;
    import com.pulumi.aws.cloudwatchomni.inputs.DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
                .build());
    
            var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
                .identityProviderConfiguration(DomainIdentityProviderConfigurationArgs.builder()
                    .identityCenterConfiguration(DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs.builder()
                        .identityCenterInstanceArn(example.arns()[0])
                        .build())
                    .build())
                .name("example")
                .identityProviders(            
                    "IAM",
                    "IDC")
                .build());
    
        }
    }
    
    resources:
      exampleDomain:
        type: aws:cloudwatchomni:Domain
        name: example
        properties:
          identityProviderConfiguration:
            identityCenterConfiguration:
              identityCenterInstanceArn: ${example.arns[0]}
          name: example
          identityProviders:
            - IAM
            - IDC
    variables:
      example:
        fn::invoke:
          function: aws:ssoadmin:getInstances
          arguments: {}
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_ssoadmin_getinstances" "example" {
    }
    
    resource "aws_cloudwatchomni_domain" "example" {
      identity_provider_configuration = {
        identity_center_configuration = {
          identity_center_instance_arn = data.aws_ssoadmin_getinstances.example.arns[0]
        }
      }
      name               = "example"
      identity_providers = ["IAM", "IDC"]
    }
    

    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[str]] = None,
               identity_provider_configuration: Optional[DomainIdentityProviderConfigurationArgs] = None,
               name: Optional[str] = None,
               region: Optional[str] = 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:cloudwatchomni:Domain
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_cloudwatchomni_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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsDomainResource = new Aws.CloudWatchOmni.Domain("awsDomainResource", new()
    {
        IdentityProviders = new[]
        {
            "string",
        },
        IdentityProviderConfiguration = new Aws.CloudWatchOmni.Inputs.DomainIdentityProviderConfigurationArgs
        {
            IdentityCenterConfiguration = new Aws.CloudWatchOmni.Inputs.DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs
            {
                IdentityCenterInstanceArn = "string",
            },
        },
        Name = "string",
        Region = "string",
    });
    
    example, err := cloudwatchomni.NewDomain(ctx, "awsDomainResource", &cloudwatchomni.DomainArgs{
    	IdentityProviders: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	IdentityProviderConfiguration: &cloudwatchomni.DomainIdentityProviderConfigurationArgs{
    		IdentityCenterConfiguration: &cloudwatchomni.DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs{
    			IdentityCenterInstanceArn: pulumi.String("string"),
    		},
    	},
    	Name:   pulumi.String("string"),
    	Region: pulumi.String("string"),
    })
    
    resource "aws_cloudwatchomni_domain" "awsDomainResource" {
      lifecycle {
        create_before_destroy = true
      }
      identity_providers = ["string"]
      identity_provider_configuration = {
        identity_center_configuration = {
          identity_center_instance_arn = "string"
        }
      }
      name   = "string"
      region = "string"
    }
    
    var awsDomainResource = new com.pulumi.aws.cloudwatchomni.Domain("awsDomainResource", com.pulumi.aws.cloudwatchomni.DomainArgs.builder()
        .identityProviders("string")
        .identityProviderConfiguration(DomainIdentityProviderConfigurationArgs.builder()
            .identityCenterConfiguration(DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs.builder()
                .identityCenterInstanceArn("string")
                .build())
            .build())
        .name("string")
        .region("string")
        .build());
    
    aws_domain_resource = aws.cloudwatchomni.Domain("awsDomainResource",
        identity_providers=["string"],
        identity_provider_configuration={
            "identity_center_configuration": {
                "identity_center_instance_arn": "string",
            },
        },
        name="string",
        region="string")
    
    const awsDomainResource = new aws.cloudwatchomni.Domain("awsDomainResource", {
        identityProviders: ["string"],
        identityProviderConfiguration: {
            identityCenterConfiguration: {
                identityCenterInstanceArn: "string",
            },
        },
        name: "string",
        region: "string",
    });
    
    type: aws:cloudwatchomni:Domain
    properties:
        identityProviderConfiguration:
            identityCenterConfiguration:
                identityCenterInstanceArn: string
        identityProviders:
            - string
        name: string
        region: string
    

    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<string>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    IdentityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    Name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    IdentityProviders []string
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    IdentityProviderConfiguration DomainIdentityProviderConfigurationArgs
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    Name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    identity_providers list(string)
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    identity_provider_configuration object
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    identityProviders List<String>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    name String

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    identityProviders string[]
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    identity_providers Sequence[str]
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    identity_provider_configuration DomainIdentityProviderConfigurationArgs
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    name str

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    identityProviders List<String>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    identityProviderConfiguration Property Map
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    name String

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

    Arn string
    ARN of the domain.
    CustomEndpointUrls List<string>
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    DomainId string
    Unique identifier of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    Arn string
    ARN of the domain.
    CustomEndpointUrls []string
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    DomainId string
    Unique identifier of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    arn string
    ARN of the domain.
    custom_endpoint_urls list(string)
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url string
    HTTPS endpoint URL for accessing the domain.
    domain_id string
    Unique identifier of the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    identity_center_application_arn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    arn String
    ARN of the domain.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    HTTPS endpoint URL for accessing the domain.
    domainId String
    Unique identifier of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    arn string
    ARN of the domain.
    customEndpointUrls string[]
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    domainId string
    Unique identifier of the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    arn str
    ARN of the domain.
    custom_endpoint_urls Sequence[str]
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url str
    HTTPS endpoint URL for accessing the domain.
    domain_id str
    Unique identifier of the domain.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_center_application_arn str
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    arn String
    ARN of the domain.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    HTTPS endpoint URL for accessing the domain.
    domainId String
    Unique identifier of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.

    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>, state?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            custom_endpoint_urls: Optional[Sequence[str]] = None,
            domain_endpoint_url: Optional[str] = None,
            domain_id: Optional[str] = None,
            identity_center_application_arn: Optional[str] = None,
            identity_provider_configuration: Optional[DomainIdentityProviderConfigurationArgs] = None,
            identity_providers: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            region: Optional[str] = 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, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    resources:  _:    type: aws:cloudwatchomni:Domain    get:      id: ${id}
    import {
      to = aws_cloudwatchomni_domain.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the domain.
    CustomEndpointUrls List<string>
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    DomainId string
    Unique identifier of the domain.
    IdentityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    IdentityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    IdentityProviders List<string>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    Name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Arn string
    ARN of the domain.
    CustomEndpointUrls []string
    Additional endpoint URLs derived from the domain name.
    DomainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    DomainId string
    Unique identifier of the domain.
    IdentityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    IdentityProviderConfiguration DomainIdentityProviderConfigurationArgs
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    IdentityProviders []string
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    Name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    arn string
    ARN of the domain.
    custom_endpoint_urls list(string)
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url string
    HTTPS endpoint URL for accessing the domain.
    domain_id string
    Unique identifier of the domain.
    identity_center_application_arn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    identity_provider_configuration object
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    identity_providers list(string)
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    arn String
    ARN of the domain.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    HTTPS endpoint URL for accessing the domain.
    domainId String
    Unique identifier of the domain.
    identityCenterApplicationArn String
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    identityProviders List<String>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    name String

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    arn string
    ARN of the domain.
    customEndpointUrls string[]
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl string
    HTTPS endpoint URL for accessing the domain.
    domainId string
    Unique identifier of the domain.
    identityCenterApplicationArn string
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    identityProviderConfiguration DomainIdentityProviderConfiguration
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    identityProviders string[]
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    name string

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    arn str
    ARN of the domain.
    custom_endpoint_urls Sequence[str]
    Additional endpoint URLs derived from the domain name.
    domain_endpoint_url str
    HTTPS endpoint URL for accessing the domain.
    domain_id str
    Unique identifier of the domain.
    identity_center_application_arn str
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    identity_provider_configuration DomainIdentityProviderConfigurationArgs
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    identity_providers Sequence[str]
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    name str

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    arn String
    ARN of the domain.
    customEndpointUrls List<String>
    Additional endpoint URLs derived from the domain name.
    domainEndpointUrl String
    HTTPS endpoint URL for accessing the domain.
    domainId String
    Unique identifier of the domain.
    identityCenterApplicationArn String
    ARN of the IAM Identity Center application. Only set when identityProviders includes IDC.
    identityProviderConfiguration Property Map
    Identity provider configuration. Required when identityProviders includes IDC. See below.
    identityProviders List<String>
    Set of identity providers that users can sign in with. Valid values: IAM, IDC.
    name String

    Name of the domain. Must be 3-63 characters, contain only lowercase letters, numbers, and hyphens, begin and end with a letter or number, and not contain consecutive hyphens. Changing the name changes the domain's custom endpoint URLs.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Supporting Types

    DomainIdentityProviderConfiguration, DomainIdentityProviderConfigurationArgs

    identity_center_configuration object
    IAM Identity Center configuration. See below.
    identityCenterConfiguration Property Map
    IAM Identity Center configuration. See below.

    DomainIdentityProviderConfigurationIdentityCenterConfiguration, DomainIdentityProviderConfigurationIdentityCenterConfigurationArgs

    IdentityCenterInstanceArn string
    ARN of the IAM Identity Center instance.
    IdentityCenterInstanceArn string
    ARN of the IAM Identity Center instance.
    identity_center_instance_arn string
    ARN of the IAM Identity Center instance.
    identityCenterInstanceArn String
    ARN of the IAM Identity Center instance.
    identityCenterInstanceArn string
    ARN of the IAM Identity Center instance.
    identity_center_instance_arn str
    ARN of the IAM Identity Center instance.
    identityCenterInstanceArn String
    ARN of the IAM Identity Center instance.

    Import

    Identity Schema

    Required

    • domainId (String) Domain ID.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import a CloudWatch Omni Domain by domain ID. For example:

    $ pulumi import aws:cloudwatchomni/domain:Domain example d-0123456789abcdefghijklmno
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.51.1
    published on Friday, Oct 16, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial