CustomerManagedPolicyAttachmentsExclusive class

Resource for managing exclusive AWS SSO Admin Customer Managed Policy Attachments.

This resource is designed to manage all customer managed policy attachments for an SSO permission set. Using this resource, Terraform will remove any customer managed policies attached to the permission set that are not defined in the configuration.

> WARNING: Do not use this resource together with the aws.ssoadmin.CustomerManagedPolicyAttachment resource for the same permission set. Doing so will cause a conflict and will lead to customer managed policies being removed.

> Destruction of this resource means Terraform will no longer manage the customer managed policy attachments, but will not detach any policies. The permission set will retain all customer managed policies that were attached at the time of destruction.

Example Usage

Basic Usage

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

const example = aws.ssoadmin.getInstances({});
const examplePermissionSet = new aws.ssoadmin.PermissionSet("example", {
    name: "Example",
    instanceArn: example.then(example => example.arns?.[0]),
});
const examplePolicy = new aws.iam.Policy("example", {
    name: "TestPolicy",
    description: "My test policy",
    policy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: ["ec2:Describe*"],
            Effect: "Allow",
            Resource: "*",
        }],
    }),
});
const exampleCustomerManagedPolicyAttachmentsExclusive = new aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive("example", {
    customerManagedPolicyReferences: [{
        name: examplePolicy.name,
        path: "/",
    }],
    instanceArn: example.then(example => example.arns?.[0]),
    permissionSetArn: examplePermissionSet.arn,
});
import pulumi
import json
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_permission_set = aws.ssoadmin.PermissionSet("example",
    name="Example",
    instance_arn=example.arns[0])
example_policy = aws.iam.Policy("example",
    name="TestPolicy",
    description="My test policy",
    policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": ["ec2:Describe*"],
            "Effect": "Allow",
            "Resource": "*",
        }],
    }))
example_customer_managed_policy_attachments_exclusive = aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive("example",
    customer_managed_policy_references=[{
        "name": example_policy.name,
        "path": "/",
    }],
    instance_arn=example.arns[0],
    permission_set_arn=example_permission_set.arn)
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.SsoAdmin.GetInstances.Invoke();

    var examplePermissionSet = new Aws.SsoAdmin.PermissionSet("example", new()
    {
        Name = "Example",
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
    });

    var examplePolicy = new Aws.Iam.Policy("example", new()
    {
        Name = "TestPolicy",
        Description = "My test policy",
        PolicyDocument = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Action"] = new[]
                    {
                        "ec2:Describe*",
                    },
                    ["Effect"] = "Allow",
                    ["Resource"] = "*",
                },
            },
        }),
    });

    var exampleCustomerManagedPolicyAttachmentsExclusive = new Aws.SsoAdmin.CustomerManagedPolicyAttachmentsExclusive("example", new()
    {
        CustomerManagedPolicyReferences = new[]
        {
            new Aws.SsoAdmin.Inputs.CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReferenceArgs
            {
                Name = examplePolicy.Name,
                Path = "/",
            },
        },
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
        PermissionSetArn = examplePermissionSet.Arn,
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"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
		}
		examplePermissionSet, err := ssoadmin.NewPermissionSet(ctx, "example", &ssoadmin.PermissionSetArgs{
			Name:        pulumi.String("Example"),
			InstanceArn: pulumi.String(example.Arns[0]),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": []string{
						"ec2:Describe*",
					},
					"Effect":   "Allow",
					"Resource": "*",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		examplePolicy, err := iam.NewPolicy(ctx, "example", &iam.PolicyArgs{
			Name:        pulumi.String("TestPolicy"),
			Description: pulumi.String("My test policy"),
			Policy:      pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		_, err = ssoadmin.NewCustomerManagedPolicyAttachmentsExclusive(ctx, "example", &ssoadmin.CustomerManagedPolicyAttachmentsExclusiveArgs{
			CustomerManagedPolicyReferences: ssoadmin.CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReferenceArray{
				&ssoadmin.CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReferenceArgs{
					Name: examplePolicy.Name,
					Path: pulumi.String("/"),
				},
			},
			InstanceArn:      pulumi.String(example.Arns[0]),
			PermissionSetArn: examplePermissionSet.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ssoadmin_getinstances" "example" {
}

resource "aws_ssoadmin_permissionset" "example" {
  name         = "Example"
  instance_arn = data.aws_ssoadmin_getinstances.example.arns[0]
}
resource "aws_iam_policy" "example" {
  name        = "TestPolicy"
  description = "My test policy"
  policy = jsonencode({
    "Version" = "2012-10-17"
    "Statement" = [{
      "Action"   = ["ec2:Describe*"]
      "Effect"   = "Allow"
      "Resource" = "*"
    }]
  })
}
resource "aws_ssoadmin_customermanagedpolicyattachmentsexclusive" "example" {
  customer_managed_policy_references {
    name = aws_iam_policy.example.name
    path = "/"
  }
  instance_arn       = data.aws_ssoadmin_getinstances.example.arns[0]
  permission_set_arn = aws_ssoadmin_permissionset.example.arn
}
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.PermissionSet;
import com.pulumi.aws.ssoadmin.PermissionSetArgs;
import com.pulumi.aws.iam.Policy;
import com.pulumi.aws.iam.PolicyArgs;
import com.pulumi.aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive;
import com.pulumi.aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusiveArgs;
import com.pulumi.aws.ssoadmin.inputs.CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReferenceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 examplePermissionSet = new PermissionSet("examplePermissionSet", PermissionSetArgs.builder()
            .name("Example")
            .instanceArn(example.arns()[0])
            .build());

        var examplePolicy = new Policy("examplePolicy", PolicyArgs.builder()
            .name("TestPolicy")
            .description("My test policy")
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Action", jsonArray("ec2:Describe*")),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Resource", "*")
                    )))
                )))
            .build());

        var exampleCustomerManagedPolicyAttachmentsExclusive = new CustomerManagedPolicyAttachmentsExclusive("exampleCustomerManagedPolicyAttachmentsExclusive", CustomerManagedPolicyAttachmentsExclusiveArgs.builder()
            .customerManagedPolicyReferences(CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReferenceArgs.builder()
                .name(examplePolicy.name())
                .path("/")
                .build())
            .instanceArn(example.arns()[0])
            .permissionSetArn(examplePermissionSet.arn())
            .build());

    }
}
resources:
  examplePermissionSet:
    type: aws:ssoadmin:PermissionSet
    name: example
    properties:
      name: Example
      instanceArn: ${example.arns[0]}
  examplePolicy:
    type: aws:iam:Policy
    name: example
    properties:
      name: TestPolicy
      description: My test policy
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Action:
                - ec2:Describe*
              Effect: Allow
              Resource: '*'
  exampleCustomerManagedPolicyAttachmentsExclusive:
    type: aws:ssoadmin:CustomerManagedPolicyAttachmentsExclusive
    name: example
    properties:
      customerManagedPolicyReferences:
        - name: ${examplePolicy.name}
          path: /
      instanceArn: ${example.arns[0]}
      permissionSetArn: ${examplePermissionSet.arn}
variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}

Disallow Customer Managed Policy Attachments

To disallow all customer managed policy attachments, omit the customerManagedPolicyReference block.

> Any customer managed policies attached to the permission set will be removed.

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

const example = new aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive("example", {
    instanceArn: exampleAwsSsoadminInstances.arns[0],
    permissionSetArn: exampleAwsSsoadminPermissionSet.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive("example",
    instance_arn=example_aws_ssoadmin_instances["arns"][0],
    permission_set_arn=example_aws_ssoadmin_permission_set["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SsoAdmin.CustomerManagedPolicyAttachmentsExclusive("example", new()
    {
        InstanceArn = exampleAwsSsoadminInstances.Arns[0],
        PermissionSetArn = exampleAwsSsoadminPermissionSet.Arn,
    });

});
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 {
		_, err := ssoadmin.NewCustomerManagedPolicyAttachmentsExclusive(ctx, "example", &ssoadmin.CustomerManagedPolicyAttachmentsExclusiveArgs{
			InstanceArn:      pulumi.Any(exampleAwsSsoadminInstances.Arns[0]),
			PermissionSetArn: pulumi.Any(exampleAwsSsoadminPermissionSet.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ssoadmin_customermanagedpolicyattachmentsexclusive" "example" {
  instance_arn       = exampleAwsSsoadminInstances.arns[0]
  permission_set_arn = exampleAwsSsoadminPermissionSet.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusive;
import com.pulumi.aws.ssoadmin.CustomerManagedPolicyAttachmentsExclusiveArgs;
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 CustomerManagedPolicyAttachmentsExclusive("example", CustomerManagedPolicyAttachmentsExclusiveArgs.builder()
            .instanceArn(exampleAwsSsoadminInstances.arns()[0])
            .permissionSetArn(exampleAwsSsoadminPermissionSet.arn())
            .build());

    }
}
resources:
  example:
    type: aws:ssoadmin:CustomerManagedPolicyAttachmentsExclusive
    properties:
      instanceArn: ${exampleAwsSsoadminInstances.arns[0]}
      permissionSetArn: ${exampleAwsSsoadminPermissionSet.arn}

Import

Identity Schema

Required

  • instanceArn (String) ARN of the SSO Instance.
  • permissionSetArn (String) ARN of the Permission Set.

Optional

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

Using pulumi import, import SSO Admin Customer Managed Policy Attachments Exclusive using the instanceArn and permissionSetArn arguments, separated by a comma (,). For example:

$ pulumi import aws:ssoadmin/customerManagedPolicyAttachmentsExclusive:CustomerManagedPolicyAttachmentsExclusive example arn:aws:sso:::instance/ssoins-1234567890abcdef,arn:aws:sso:::permissionSet/ssoins-1234567890abcdef/ps-1234567890abcdef

Constructors

CustomerManagedPolicyAttachmentsExclusive(String name, {CustomerManagedPolicyAttachmentsExclusiveArgs? args, CustomResourceOptions? options})
Creates a new CustomerManagedPolicyAttachmentsExclusive. name The Pulumi resource name. args Arguments used to configure this CustomerManagedPolicyAttachmentsExclusive. The set of arguments for CustomerManagedPolicyAttachmentsExclusive. options Resource options controlling this resource's behavior.
CustomerManagedPolicyAttachmentsExclusive.reference(String urn)
Creates a typed reference to an existing CustomerManagedPolicyAttachmentsExclusive resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
customerManagedPolicyReferences ↔ Output<List<CustomerManagedPolicyAttachmentsExclusiveCustomerManagedPolicyReference>?>
Specifies the names and paths of the customer managed policies to attach. See Customer Managed Policy Reference below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceArn ↔ Output<String>
ARN of the SSO 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
permissionSetArn ↔ Output<String>
ARN of the Permission Set.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeouts ↔ Output<CustomerManagedPolicyAttachmentsExclusiveTimeouts?>
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

Static Methods

get(String name, Input<String> id, {CustomerManagedPolicyAttachmentsExclusiveState? state, CustomResourceOptions? options}) → CustomerManagedPolicyAttachmentsExclusive
Gets an existing CustomerManagedPolicyAttachmentsExclusive resource's state with the given name and id.