Interface CreateOrganizationalUnitRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>,OrganizationsRequest.Builder,SdkBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateOrganizationalUnitRequest
public static interface CreateOrganizationalUnitRequest.Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder<CreateOrganizationalUnitRequest.Builder,CreateOrganizationalUnitRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateOrganizationalUnitRequest.Buildername(String name)The friendly name to assign to the new OU.CreateOrganizationalUnitRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateOrganizationalUnitRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateOrganizationalUnitRequest.BuilderparentId(String parentId)The unique identifier (ID) of the parent root or OU that you want to create the new OU in.CreateOrganizationalUnitRequest.Buildertags(Collection<Tag> tags)A list of tags that you want to attach to the newly created OU.CreateOrganizationalUnitRequest.Buildertags(Consumer<Tag.Builder>... tags)A list of tags that you want to attach to the newly created OU.CreateOrganizationalUnitRequest.Buildertags(Tag... tags)A list of tags that you want to attach to the newly created OU.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.organizations.model.OrganizationsRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
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 tonull. 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 tonull. 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. This is a convenience method that creates an instance of theIf 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.
Tag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
overrideConfiguration
CreateOrganizationalUnitRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateOrganizationalUnitRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-