Package software.amazon.awscdk.services.organizations

Class CfnPolicyProps.Builder

java.lang.Object
software.amazon.awscdk.services.organizations.CfnPolicyProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPolicyProps>
Enclosing interface:
CfnPolicyProps
@Stability(Stable) public static final class CfnPolicyProps.Builder extends Object implements software.amazon.jsii.Builder<CfnPolicyProps>
A builder for CfnPolicyProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • content

      @Stability(Stable) public CfnPolicyProps.Builder content(Object content)
      Sets the value of CfnPolicyProps.getContent()
      Parameters:
      content - The policy text content. You can specify the policy content as a JSON object or a JSON string. This parameter is required.

      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
      • AI services opt-out policies: 2,500 characters
      • Backup policies: 10,000 characters
      • Tag policies: 10,000 characters

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

      Returns:
      this

    • name

      @Stability(Stable) public CfnPolicyProps.Builder name(String name)
      Sets the value of CfnPolicyProps.getName()
      Parameters:
      name - Name of the policy. This parameter is required. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
      Returns:
      this

    • type

      @Stability(Stable) public CfnPolicyProps.Builder type(String type)
      Sets the value of CfnPolicyProps.getType()
      Parameters:
      type - The type of policy to create. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnPolicyProps.Builder description(String description)
      Sets the value of CfnPolicyProps.getDescription()
      Parameters:
      description - Human readable description of the policy.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnPolicyProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnPolicyProps.getTags()
      Parameters:
      tags - 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.

      Returns:
      this

    • targetIds

      @Stability(Stable) public CfnPolicyProps.Builder targetIds(List<String> targetIds)
      Sets the value of CfnPolicyProps.getTargetIds()
      Parameters:
      targetIds - 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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnPolicyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPolicyProps>
      Returns:
      a new instance of CfnPolicyProps
      Throws:
      NullPointerException - if any required attribute was not provided