@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
137 lines (136 loc) • 6.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage a resource-based delegation policy that can be used to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account. See the [_AWS Organizations User Guide_](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_delegate_policies.html) for more information.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.organizations.ResourcePolicy("example", {content: `{
* \\"Version\\": \\"2012-10-17\\",
* \\"Statement\\": [
* {
* \\"Sid\\": \\"DelegatingNecessaryDescribeListActions\\",
* \\"Effect\\": \\"Allow\\",
* \\"Principal\\": {
* \\"AWS\\": \\"arn:aws:iam::123456789012:root\\"
* },
* \\"Action\\": [
* \\"organizations:DescribeOrganization\\",
* \\"organizations:DescribeOrganizationalUnit\\",
* \\"organizations:DescribeAccount\\",
* \\"organizations:DescribePolicy\\",
* \\"organizations:DescribeEffectivePolicy\\",
* \\"organizations:ListRoots\\",
* \\"organizations:ListOrganizationalUnitsForParent\\",
* \\"organizations:ListParents\\",
* \\"organizations:ListChildren\\",
* \\"organizations:ListAccounts\\",
* \\"organizations:ListAccountsForParent\\",
* \\"organizations:ListPolicies\\",
* \\"organizations:ListPoliciesForTarget\\",
* \\"organizations:ListTargetsForPolicy\\",
* \\"organizations:ListTagsForResource\\"
* ],
* \\"Resource\\": \\"*\\"
* }
* ]
* }
* `});
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_organizations_resource_policy` using the resource policy ID. For example:
*
* ```sh
* $ pulumi import aws:organizations/resourcePolicy:ResourcePolicy example rp-12345678
* ```
*/
export declare class ResourcePolicy extends pulumi.CustomResource {
/**
* Get an existing ResourcePolicy 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: string, id: pulumi.Input<pulumi.ID>, state?: ResourcePolicyState, opts?: pulumi.CustomResourceOptions): ResourcePolicy;
/**
* Returns true if the given object is an instance of ResourcePolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ResourcePolicy;
/**
* Amazon Resource Name (ARN) of the resource policy.
*/
readonly arn: pulumi.Output<string>;
/**
* Content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. See the [_AWS Organizations User Guide_](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_delegate_examples.html) for examples.
*/
readonly content: pulumi.Output<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a ResourcePolicy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ResourcePolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ResourcePolicy resources.
*/
export interface ResourcePolicyState {
/**
* Amazon Resource Name (ARN) of the resource policy.
*/
arn?: pulumi.Input<string>;
/**
* Content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. See the [_AWS Organizations User Guide_](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_delegate_examples.html) for examples.
*/
content?: pulumi.Input<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a ResourcePolicy resource.
*/
export interface ResourcePolicyArgs {
/**
* Content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. See the [_AWS Organizations User Guide_](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_delegate_examples.html) for examples.
*/
content: pulumi.Input<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}