@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
129 lines • 5.52 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.PermissionsBoundaryAttachment = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Attaches a permissions boundary policy to a Single Sign-On (SSO) Permission Set resource.
*
* > **NOTE:** A permission set can have at most one permissions boundary attached; using more than one `aws.ssoadmin.PermissionsBoundaryAttachment` references the same permission set will show a permanent difference.
*
* ## Example Usage
*
* ### Attaching a customer-managed policy
*
* ```typescript
* 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 examplePermissionsBoundaryAttachment = new aws.ssoadmin.PermissionsBoundaryAttachment("example", {
* instanceArn: examplePermissionSet.instanceArn,
* permissionSetArn: examplePermissionSet.arn,
* permissionsBoundary: {
* customerManagedPolicyReference: {
* name: examplePolicy.name,
* path: "/",
* },
* },
* });
* ```
*
* ### Attaching an AWS-managed policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ssoadmin.PermissionsBoundaryAttachment("example", {
* instanceArn: exampleAwsSsoadminPermissionSet.instanceArn,
* permissionSetArn: exampleAwsSsoadminPermissionSet.arn,
* permissionsBoundary: {
* managedPolicyArn: "arn:aws:iam::aws:policy/ReadOnlyAccess",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import SSO Admin Permissions Boundary Attachments using the `permission_set_arn` and `instance_arn`, separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:ssoadmin/permissionsBoundaryAttachment:PermissionsBoundaryAttachment example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72
* ```
*/
class PermissionsBoundaryAttachment extends pulumi.CustomResource {
/**
* Get an existing PermissionsBoundaryAttachment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new PermissionsBoundaryAttachment(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of PermissionsBoundaryAttachment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === PermissionsBoundaryAttachment.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["instanceArn"] = state?.instanceArn;
resourceInputs["permissionSetArn"] = state?.permissionSetArn;
resourceInputs["permissionsBoundary"] = state?.permissionsBoundary;
resourceInputs["region"] = state?.region;
}
else {
const args = argsOrState;
if (args?.instanceArn === undefined && !opts.urn) {
throw new Error("Missing required property 'instanceArn'");
}
if (args?.permissionSetArn === undefined && !opts.urn) {
throw new Error("Missing required property 'permissionSetArn'");
}
if (args?.permissionsBoundary === undefined && !opts.urn) {
throw new Error("Missing required property 'permissionsBoundary'");
}
resourceInputs["instanceArn"] = args?.instanceArn;
resourceInputs["permissionSetArn"] = args?.permissionSetArn;
resourceInputs["permissionsBoundary"] = args?.permissionsBoundary;
resourceInputs["region"] = args?.region;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(PermissionsBoundaryAttachment.__pulumiType, name, resourceInputs, opts);
}
}
exports.PermissionsBoundaryAttachment = PermissionsBoundaryAttachment;
/** @internal */
PermissionsBoundaryAttachment.__pulumiType = 'aws:ssoadmin/permissionsBoundaryAttachment:PermissionsBoundaryAttachment';
//# sourceMappingURL=permissionsBoundaryAttachment.js.map