Region class
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")
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 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
})
}
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"
}
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: {}
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
Constructors
- Region(String name, {RegionArgs? args, CustomResourceOptions? options})
-
Creates a new Region.
nameThe Pulumi resource name.argsArguments used to configure this Region. The set of arguments for Region.optionsResource options controlling this resource's behavior. - Region.reference(String urn)
- Creates a typed reference to an existing Region resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceArn
↔ Output<
String> -
ARN of the IAM Identity Center instance.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where Terraform calls the SSO Admin API for this resource. Defaults to the Region in the provider configuration.
latefinal
-
regionName
↔ Output<
String> -
AWS Region to add (for example,
us-east-1). Changing this forces a new resource.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
Current Region status. Valid values are
ACTIVE,ADDING, andREMOVING.latefinal -
timeouts
↔ Output<
RegionTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited