Class Region


  • public class Region
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS SSO Admin Region. Adds another AWS Region to an IAM Identity Center instance. This operation runs asynchronously, and Terraform waits until the Region status becomes `ACTIVE`. > For a given instance, only one Region add or remove operation can run at a time. If you manage multiple regions, apply them one at a time or use `dependsOn`. > The primary Region of an IAM Identity Center instance cannot be removed. ## Example Usage ### Basic Usage
     
     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.ssoadmin.Region;
     import com.pulumi.aws.ssoadmin.RegionArgs;
     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 exampleRegion = new Region("exampleRegion", RegionArgs.builder()
                 .instanceArn(example.arns()[0])
                 .regionName("us-east-1")
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `instanceArn` (String) ARN of the IAM Identity Center instance. * `regionName` (String) Name of the AWS Region. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import this resource with `instanceArn` and `regionName` separated by a comma (`,`). For example: ```sh $ pulumi import aws:ssoadmin/region:Region example arn:aws:sso:::instance/ssoins-1234567890abcdef,us-east-1 ```
    • 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
      Region​(java.lang.String name)  
      Region​(java.lang.String name, RegionArgs args)  
      Region​(java.lang.String name, RegionArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Region get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RegionState 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> instanceArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> regionName()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<RegionTimeouts>> timeouts()  
      • 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

      • Region

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

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

        public Region​(java.lang.String name,
                      RegionArgs 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

      • instanceArn

        public com.pulumi.core.Output<java.lang.String> instanceArn()
        Returns:
        ARN of the IAM Identity Center instance.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
      • regionName

        public com.pulumi.core.Output<java.lang.String> regionName()
        Returns:
        AWS Region to add (for example, `us-east-1`). Changing this forces a new resource. The following arguments are optional:
      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current Region status. Valid values are `ACTIVE`, `ADDING`, and `REMOVING`.
      • timeouts

        public com.pulumi.core.Output<java.util.Optional<RegionTimeouts>> timeouts()
      • get

        public static Region get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 RegionState 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.