Interface CreateOrganizationalUnitRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>, OrganizationsRequest.Builder, SdkBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateOrganizationalUnitRequest
@Mutable @NotThreadSafe public static interface CreateOrganizationalUnitRequest.Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>

  • Method Details

    • parentId

      CreateOrganizationalUnitRequest.Builder parentId(String parentId)

      The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

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

      • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or 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.

      Parameters:
      parentId - The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

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

      • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or 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:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateOrganizationalUnitRequest.Builder name(String name)

      The friendly name to assign to the new OU.

      Parameters:
      name - The friendly name to assign to the new OU.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateOrganizationalUnitRequest.Builder tags(Collection<Tag> tags)

      A list of tags that you want to attach to the newly created OU. 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 Organizations resources in the Organizations User Guide.

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

      Parameters:
      tags - A list of tags that you want to attach to the newly created OU. 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 Organizations resources in the Organizations User Guide.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateOrganizationalUnitRequest.Builder tags(Tag... tags)

      A list of tags that you want to attach to the newly created OU. 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 Organizations resources in the Organizations User Guide.

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

      Parameters:
      tags - A list of tags that you want to attach to the newly created OU. 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 Organizations resources in the Organizations User Guide.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateOrganizationalUnitRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags that you want to attach to the newly created OU. 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 Organizations resources in the Organizations User Guide.

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateOrganizationalUnitRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateOrganizationalUnitRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.