Package software.amazon.awscdk.services.organizations

Interface CfnPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:22.694Z")
@Stability(Stable)
public interface CfnPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.organizations.*;
 Object content;
 CfnPolicyProps cfnPolicyProps = CfnPolicyProps.builder()
         .content(content)
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetIds(List.of("targetIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPolicyProps.Builder	A builder for CfnPolicyProps
static final class	CfnPolicyProps.Jsii$Proxy	An implementation for CfnPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnPolicyProps.Builder	builder()
Object	getContent()	The policy text content.
default String	getDescription()	Human readable description of the policy.
String	getName()	Name of the policy.
default List<CfnTag>	getTags()	A list of tags that you want to attach to the newly created policy.
default List<String>	getTargetIds()	List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to.
String	getType()	The type of policy to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContent

@Stability(Stable)
@NotNull
Object getContent()

The policy text content. You can specify the policy content as a JSON object or a JSON string.

When you specify the policy content as a JSON string, you can't perform drift detection on the CloudFormation stack. For this reason, we recommend specifying the policy content as a JSON object instead.

The text that you supply must adhere to the rules of the policy type you specify in the Type parameter. The following AWS Organizations quotas are enforced for the maximum size of a policy document:

• Service control policies: 5,120 characters
• Resource control policies: 5,120 characters
• Declarative policies: 10,000 characters
• Backup policies: 10,000 characters
• Tag policies: 10,000 characters
• Chatbot policies: 10,000 characters
• AI services opt-out policies: 2,500 characters

For more information about Organizations service quotas, see Quotas for AWS Organizations in the AWS Organizations User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-content

getName

@Stability(Stable)
@NotNull
String getName()

Name of the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-name

getType

@Stability(Stable)
@NotNull
String getType()

The type of policy to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-type

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Human readable description of the policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-description

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 . For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-tags

getTargetIds

@Stability(Stable)
@Nullable
default List<String> getTargetIds()

List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to.

You can get the ID by calling the ListRoots , ListOrganizationalUnitsForParent , or ListAccounts operations. If you don't specify this parameter, the policy is created but not attached to any organization resource.

The regex pattern for a target ID string requires one of the following:

• Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
• Account - A string that consists of exactly 12 digits.
• Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-organizations-policy.html#cfn-organizations-policy-targetids

builder

@Stability(Stable)
static CfnPolicyProps.Builder builder()

Returns:

a CfnPolicyProps.Builder of CfnPolicyProps