Package com.pulumi.aws.cloudwatchomni

Class Domain

  • public class Domain
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ### With IAM Identity Center 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:cloudwatchomni/domain:Domain example d-0123456789abcdefghijklmno ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Domain​(java.lang.String name)  
      Domain​(java.lang.String name, DomainArgs args)  
      Domain​(java.lang.String name, DomainArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> customEndpointUrls()  
      com.pulumi.core.Output<java.lang.String> domainEndpointUrl()  
      com.pulumi.core.Output<java.lang.String> domainId()  
      static Domain get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identityCenterApplicationArn()  
      com.pulumi.core.Output<java.util.Optional<DomainIdentityProviderConfiguration>> identityProviderConfiguration()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> identityProviders()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Domain

        public Domain​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Domain

        public Domain​(java.lang.String name,
              DomainArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Domain

        public Domain​(java.lang.String name,
              DomainArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the domain.

      • customEndpointUrls

        public com.pulumi.core.Output<java.util.List<java.lang.String>> customEndpointUrls()
        Returns:
        Additional endpoint URLs derived from the domain name.

      • domainEndpointUrl

        public com.pulumi.core.Output<java.lang.String> domainEndpointUrl()
        Returns:
        HTTPS endpoint URL for accessing the domain.

      • domainId

        public com.pulumi.core.Output<java.lang.String> domainId()
        Returns:
        Unique identifier of the domain.

      • identityCenterApplicationArn

        public com.pulumi.core.Output<java.lang.String> identityCenterApplicationArn()
        Returns:
        ARN of the IAM Identity Center application. Only set when `identityProviders` includes `IDC`.

      • identityProviderConfiguration

        public com.pulumi.core.Output<java.util.Optional<DomainIdentityProviderConfiguration>> identityProviderConfiguration()
        Returns:
        Identity provider configuration. Required when `identityProviders` includes `IDC`. See below.

      • identityProviders

        public com.pulumi.core.Output<java.util.List<java.lang.String>> identityProviders()
        Returns:
        Set of identity providers that users can sign in with. Valid values: `IAM`, `IDC`.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static Domain get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         DomainState state,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.