Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. ssoadmin
  6. Region
Viewing docs for AWS v7.40.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.ssoadmin.Region

aws logo
Viewing docs for AWS v7.40.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ssoadmin.getInstances({});
const exampleRegion = new aws.ssoadmin.Region("example", {
    instanceArn: example.then(example => example.arns?.[0]),
    regionName: "us-east-1",
});

    import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_region = aws.ssoadmin.Region("example",
    instance_arn=example.arns[0],
    region_name="us-east-1")

    package main

import (
	"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 = ssoadmin.NewRegion(ctx, "example", &ssoadmin.RegionArgs{
			InstanceArn: pulumi.String(example.Arns[0]),
			RegionName:  pulumi.String("us-east-1"),
		})
		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 exampleRegion = new Aws.SsoAdmin.Region("example", new()
    {
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
        RegionName = "us-east-1",
    });

});

    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());

    }
}

    resources:
  exampleRegion:
    type: aws:ssoadmin:Region
    name: example
    properties:
      instanceArn: ${example.arns[0]}
      regionName: us-east-1
variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ssoadmin_getinstances" "example" {
}

resource "aws_ssoadmin_region" "example" {
  instance_arn = data.aws_ssoadmin_getinstances.example.arns[0]
  region_name  = "us-east-1"
}

    Create Region Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Region(name: string, args: RegionArgs, opts?: CustomResourceOptions);
    @overload
def Region(resource_name: str,
           args: RegionArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Region(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           instance_arn: Optional[str] = None,
           region_name: Optional[str] = None,
           region: Optional[str] = None,
           timeouts: Optional[RegionTimeoutsArgs] = None)
    func NewRegion(ctx *Context, name string, args RegionArgs, opts ...ResourceOption) (*Region, error)
    public Region(string name, RegionArgs args, CustomResourceOptions? opts = null)
    public Region(String name, RegionArgs args)
public Region(String name, RegionArgs args, CustomResourceOptions options)

    type: aws:ssoadmin:Region
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_ssoadmin_region" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RegionArgs
    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 RegionArgs
    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 RegionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionArgs
    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 awsRegionResource = new Aws.SsoAdmin.Region("awsRegionResource", new()
{
    InstanceArn = "string",
    RegionName = "string",
    AwsRegion = "string",
    Timeouts = new Aws.SsoAdmin.Inputs.RegionTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := ssoadmin.NewRegion(ctx, "awsRegionResource", &ssoadmin.RegionArgs{
	InstanceArn: pulumi.String("string"),
	RegionName:  pulumi.String("string"),
	Region:      pulumi.String("string"),
	Timeouts: &ssoadmin.RegionTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    resource "aws_ssoadmin_region" "awsRegionResource" {
  lifecycle {
    create_before_destroy = true
  }
  instance_arn = "string"
  region_name  = "string"
  region       = "string"
  timeouts = {
    create = "string"
    delete = "string"
  }
}

    var awsRegionResource = new com.pulumi.aws.ssoadmin.Region("awsRegionResource", com.pulumi.aws.ssoadmin.RegionArgs.builder()
    .instanceArn("string")
    .regionName("string")
    .region("string")
    .timeouts(RegionTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    aws_region_resource = aws.ssoadmin.Region("awsRegionResource",
    instance_arn="string",
    region_name="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const awsRegionResource = new aws.ssoadmin.Region("awsRegionResource", {
    instanceArn: "string",
    regionName: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: aws:ssoadmin:Region
properties:
    instanceArn: string
    region: string
    regionName: string
    timeouts:
        create: string
        delete: string

    Region 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 Region resource accepts the following input properties:

    InstanceArn string
    ARN of the IAM Identity Center instance.
    RegionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    AwsRegion string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    Timeouts RegionTimeouts
    InstanceArn string
    ARN of the IAM Identity Center instance.
    RegionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    Region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    Timeouts RegionTimeoutsArgs
    instance_arn string
    ARN of the IAM Identity Center instance.
    region_name string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    timeouts object
    instanceArn String
    ARN of the IAM Identity Center instance.
    regionName String

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    region String
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    timeouts RegionTimeouts
    instanceArn string
    ARN of the IAM Identity Center instance.
    regionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    timeouts RegionTimeouts
    instance_arn str
    ARN of the IAM Identity Center instance.
    region_name str

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    region str
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    timeouts RegionTimeoutsArgs
    instanceArn String
    ARN of the IAM Identity Center instance.
    regionName String

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    region String
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.

    Look up Existing Region Resource

    Get an existing Region 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?: RegionState, opts?: CustomResourceOptions): Region
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_arn: Optional[str] = None,
        region: Optional[str] = None,
        region_name: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[RegionTimeoutsArgs] = None) -> Region
    func GetRegion(ctx *Context, name string, id IDInput, state *RegionState, opts ...ResourceOption) (*Region, error)
    public static Region Get(string name, Input<string> id, RegionState? state, CustomResourceOptions? opts = null)
    public static Region get(String name, Output<String> id, RegionState state, CustomResourceOptions options)
    resources:  _:    type: aws:ssoadmin:Region    get:      id: ${id}
    import {
  to = aws_ssoadmin_region.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:
    AwsRegion string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    InstanceArn string
    ARN of the IAM Identity Center instance.
    RegionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    Status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    Timeouts RegionTimeouts
    InstanceArn string
    ARN of the IAM Identity Center instance.
    Region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    RegionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    Status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    Timeouts RegionTimeoutsArgs
    instance_arn string
    ARN of the IAM Identity Center instance.
    region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    region_name string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    timeouts object
    instanceArn String
    ARN of the IAM Identity Center instance.
    region String
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    regionName String

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    status String
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    timeouts RegionTimeouts
    instanceArn string
    ARN of the IAM Identity Center instance.
    region string
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    regionName string

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    status string
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    timeouts RegionTimeouts
    instance_arn str
    ARN of the IAM Identity Center instance.
    region str
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    region_name str

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    status str
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    timeouts RegionTimeoutsArgs
    instanceArn String
    ARN of the IAM Identity Center instance.
    region String
    Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
    regionName String

    AWS Region to add (for example, us-east-1). Changing this forces a new resource.

    The following arguments are optional:

    status String
    Current Region status. Valid values are ACTIVE, ADDING, and REMOVING.
    timeouts Property Map

    Supporting Types

    RegionTimeouts, RegionTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    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:

    $ pulumi import aws:ssoadmin/region:Region example arn:aws:sso:::instance/ssoins-1234567890abcdef,us-east-1

    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
    Viewing docs for AWS v7.40.0
    published on Thursday, Jul 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial