@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
167 lines • 7.18 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.StackInstances = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudformation.StackInstances("example", {
* accounts: [
* "123456789012",
* "234567890123",
* ],
* regions: [
* "us-east-1",
* "us-west-2",
* ],
* stackSetName: exampleAwsCloudformationStackSet.name,
* });
* ```
*
* ### Example IAM Setup in Target Account
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy = aws.iam.getPolicyDocument({
* statements: [{
* actions: ["sts:AssumeRole"],
* effect: "Allow",
* principals: [{
* identifiers: [aWSCloudFormationStackSetAdministrationRole.arn],
* type: "AWS",
* }],
* }],
* });
* const aWSCloudFormationStackSetExecutionRole = new aws.iam.Role("AWSCloudFormationStackSetExecutionRole", {
* assumeRolePolicy: aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.then(aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy => aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.json),
* name: "AWSCloudFormationStackSetExecutionRole",
* });
* // Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
* // Additional IAM permissions necessary depend on the resources defined in the StackSet template
* const aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy = aws.iam.getPolicyDocument({
* statements: [{
* actions: [
* "cloudformation:*",
* "s3:*",
* "sns:*",
* ],
* effect: "Allow",
* resources: ["*"],
* }],
* });
* const aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy = new aws.iam.RolePolicy("AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy", {
* name: "MinimumExecutionPolicy",
* policy: aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.then(aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy => aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.json),
* role: aWSCloudFormationStackSetExecutionRole.name,
* });
* ```
*
* ### Example Deployment across Organizations account
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudformation.StackInstances("example", {
* deploymentTargets: {
* organizationalUnitIds: [exampleAwsOrganizationsOrganization.roots[0].id],
* },
* regions: [
* "us-west-2",
* "us-east-1",
* ],
* stackSetName: exampleAwsCloudformationStackSet.name,
* });
* ```
*
* ## Import
*
* Import CloudFormation stack instances that target OUs, using the stack set name, `call_as`, and "OU" separated by commas (`,`). For example:
*
* Using `pulumi import`, import CloudFormation stack instances using the stack set name and `call_as` separated by commas (`,`). If you are importing a stack instance targeting OUs, see the example below. For example:
*
* ```sh
* $ pulumi import aws:cloudformation/stackInstances:StackInstances example example,SELF
* ```
* Using `pulumi import`, Import CloudFormation stack instances that target OUs, using the stack set name, `call_as`, and "OU" separated by commas (`,`). For example:
*
* ```sh
* $ pulumi import aws:cloudformation/stackInstances:StackInstances example example,SELF,OU
* ```
*/
class StackInstances extends pulumi.CustomResource {
/**
* Get an existing StackInstances 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 StackInstances(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of StackInstances. 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'] === StackInstances.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accounts"] = state?.accounts;
resourceInputs["callAs"] = state?.callAs;
resourceInputs["deploymentTargets"] = state?.deploymentTargets;
resourceInputs["operationPreferences"] = state?.operationPreferences;
resourceInputs["parameterOverrides"] = state?.parameterOverrides;
resourceInputs["region"] = state?.region;
resourceInputs["regions"] = state?.regions;
resourceInputs["retainStacks"] = state?.retainStacks;
resourceInputs["stackInstanceSummaries"] = state?.stackInstanceSummaries;
resourceInputs["stackSetId"] = state?.stackSetId;
resourceInputs["stackSetName"] = state?.stackSetName;
}
else {
const args = argsOrState;
if (args?.stackSetName === undefined && !opts.urn) {
throw new Error("Missing required property 'stackSetName'");
}
resourceInputs["accounts"] = args?.accounts;
resourceInputs["callAs"] = args?.callAs;
resourceInputs["deploymentTargets"] = args?.deploymentTargets;
resourceInputs["operationPreferences"] = args?.operationPreferences;
resourceInputs["parameterOverrides"] = args?.parameterOverrides;
resourceInputs["region"] = args?.region;
resourceInputs["regions"] = args?.regions;
resourceInputs["retainStacks"] = args?.retainStacks;
resourceInputs["stackSetName"] = args?.stackSetName;
resourceInputs["stackInstanceSummaries"] = undefined /*out*/;
resourceInputs["stackSetId"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(StackInstances.__pulumiType, name, resourceInputs, opts);
}
}
exports.StackInstances = StackInstances;
/** @internal */
StackInstances.__pulumiType = 'aws:cloudformation/stackInstances:StackInstances';
//# sourceMappingURL=stackInstances.js.map