software.amazon.awssdk.services.organizations.model

Interface Root.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Root.Builder,Root>, SdkBuilder<Root.Builder,Root>, SdkPojo

Enclosing class:

Root

public static interface Root.Builder
extends SdkPojo, CopyableBuilder<Root.Builder,Root>

Method Summary

Modifier and Type	Method and Description
Root.Builder	arn(String arn) The Amazon Resource Name (ARN) of the root.
Root.Builder	id(String id) The unique identifier (ID) for the root.
Root.Builder	name(String name) The friendly name of the root.
Root.Builder	policyTypes(Collection<PolicyTypeSummary> policyTypes) The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.
Root.Builder	policyTypes(Consumer<PolicyTypeSummary.Builder>... policyTypes) The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.
Root.Builder	policyTypes(PolicyTypeSummary... policyTypes) The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

Root.Builder id(String id)

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Parameters:

id - The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Returns:

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

arn

Root.Builder arn(String arn)

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Parameters:

arn - The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Returns:

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

name

Root.Builder name(String name)

The friendly name of the root.

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

Parameters:

name - The friendly name of the root.

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

Returns:

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

policyTypes

Root.Builder policyTypes(Collection<PolicyTypeSummary> policyTypes)

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

Parameters:

policyTypes - The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

Returns:

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

policyTypes

Root.Builder policyTypes(PolicyTypeSummary... policyTypes)

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

Parameters:

policyTypes - The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

Returns:

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

policyTypes

Root.Builder policyTypes(Consumer<PolicyTypeSummary.Builder>... policyTypes)

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #policyTypes(List).

Parameters:

policyTypes - a consumer that will call methods on PolicyTypeSummary.Builder

Returns:

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

See Also:

#policyTypes(java.util.Collection)