Interface Account.Builder

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

  • Method Details

    • id

      Account.Builder id(String id)

      The unique identifier (ID) of the account.

      The regex pattern for an account ID string requires exactly 12 digits.

      Parameters:
      id - The unique identifier (ID) of the account.

      The regex pattern for an account ID string requires exactly 12 digits.

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

    • arn

      Account.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the account.

      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 account.

      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.

    • email

      Account.Builder email(String email)

      The email address associated with the Amazon Web Services account.

      The regex pattern for this parameter is a string of characters that represents a standard internet email address.

      Parameters:
      email - The email address associated with the Amazon Web Services account.

      The regex pattern for this parameter is a string of characters that represents a standard internet email address.

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

    • name

      Account.Builder name(String name)

      The friendly name of the account.

      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 account.

      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.

    • status

      Account.Builder status(String status)

      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      Parameters:
      status - The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

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

    • status

      Account.Builder status(AccountStatus status)

      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      Parameters:
      status - The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

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

    • state

      Account.Builder state(String state)

      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      Parameters:
      state - Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

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

    • state

      Account.Builder state(AccountState state)

      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      Parameters:
      state - Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

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

    • joinedMethod

      Account.Builder joinedMethod(String joinedMethod)

      The method by which the account joined the organization.

      Parameters:
      joinedMethod - The method by which the account joined the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • joinedMethod

      Account.Builder joinedMethod(AccountJoinedMethod joinedMethod)

      The method by which the account joined the organization.

      Parameters:
      joinedMethod - The method by which the account joined the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • joinedTimestamp

      Account.Builder joinedTimestamp(Instant joinedTimestamp)

      The date the account became a part of the organization.

      Parameters:
      joinedTimestamp - The date the account became a part of the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.