Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. organizations
  5. Policy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.organizations.Policy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.

    Create Policy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
    @overload
def Policy(resource_name: str,
           args: PolicyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           content: Optional[Any] = None,
           type: Optional[PolicyType] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           target_ids: Optional[Sequence[str]] = None)
    func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
    public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
    public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)

    type: aws-native:organizations:Policy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const examplepolicyResourceResourceFromOrganizations = new aws_native.organizations.Policy("examplepolicyResourceResourceFromOrganizations", {
    content: "any",
    type: aws_native.organizations.PolicyType.ServiceControlPolicy,
    description: "string",
    name: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    targetIds: ["string"],
});

    Coming soon!

    Policy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Policy resource accepts the following input properties:

    Content object

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    Type Pulumi.AwsNative.Organizations.PolicyType
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    Description string
    Human readable description of the policy
    Name string
    Name of the Policy
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    TargetIds List<string>
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
    Content interface{}

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    Type PolicyType
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    Description string
    Human readable description of the policy
    Name string
    Name of the Policy
    Tags TagArgs
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    TargetIds []string
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
    content Object

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    type PolicyType
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    description String
    Human readable description of the policy
    name String
    Name of the Policy
    tags List<Tag>
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    targetIds List<String>
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
    content any

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    type PolicyType
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    description string
    Human readable description of the policy
    name string
    Name of the Policy
    tags Tag[]
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    targetIds string[]
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
    content Any

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    type PolicyType
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    description str
    Human readable description of the policy
    name str
    Name of the Policy
    tags Sequence[TagArgs]
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    target_ids Sequence[str]
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
    content Any

    The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

    Search the CloudFormation User Guide for AWS::Organizations::Policy for more information about the expected schema for this property.

    type "SERVICE_CONTROL_POLICY" | "AISERVICES_OPT_OUT_POLICY" | "BACKUP_POLICY" | "TAG_POLICY"
    The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
    description String
    Human readable description of the policy
    name String
    Name of the Policy
    tags List<Property Map>
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
    targetIds List<String>
    List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:

    Arn string
    ARN of the Policy
    AwsId string
    Id of the Policy
    AwsManaged bool
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the Policy
    AwsId string
    Id of the Policy
    AwsManaged bool
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the Policy
    awsId String
    Id of the Policy
    awsManaged Boolean
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the Policy
    awsId string
    Id of the Policy
    awsManaged boolean
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the Policy
    aws_id str
    Id of the Policy
    aws_managed bool
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the Policy
    awsId String
    Id of the Policy
    awsManaged Boolean
    A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    PolicyType, PolicyTypeArgs

    ServiceControlPolicy
    SERVICE_CONTROL_POLICY
    AiservicesOptOutPolicy
    AISERVICES_OPT_OUT_POLICY
    BackupPolicy
    BACKUP_POLICY
    TagPolicy
    TAG_POLICY
    PolicyTypeServiceControlPolicy
    SERVICE_CONTROL_POLICY
    PolicyTypeAiservicesOptOutPolicy
    AISERVICES_OPT_OUT_POLICY
    PolicyTypeBackupPolicy
    BACKUP_POLICY
    PolicyTypeTagPolicy
    TAG_POLICY
    ServiceControlPolicy
    SERVICE_CONTROL_POLICY
    AiservicesOptOutPolicy
    AISERVICES_OPT_OUT_POLICY
    BackupPolicy
    BACKUP_POLICY
    TagPolicy
    TAG_POLICY
    ServiceControlPolicy
    SERVICE_CONTROL_POLICY
    AiservicesOptOutPolicy
    AISERVICES_OPT_OUT_POLICY
    BackupPolicy
    BACKUP_POLICY
    TagPolicy
    TAG_POLICY
    SERVICE_CONTROL_POLICY
    SERVICE_CONTROL_POLICY
    AISERVICES_OPT_OUT_POLICY
    AISERVICES_OPT_OUT_POLICY
    BACKUP_POLICY
    BACKUP_POLICY
    TAG_POLICY
    TAG_POLICY
    "SERVICE_CONTROL_POLICY"
    SERVICE_CONTROL_POLICY
    "AISERVICES_OPT_OUT_POLICY"
    AISERVICES_OPT_OUT_POLICY
    "BACKUP_POLICY"
    BACKUP_POLICY
    "TAG_POLICY"
    TAG_POLICY

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native