Package software.amazon.awssdk.services.ec2.model

Interface AddIpamOrganizationalUnitExclusion.Builder

    • Method Detail

      • organizationsEntityPath

        AddIpamOrganizationalUnitExclusion.Builder organizationsEntityPath​(String organizationsEntityPath)

        An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

        • Example 1

          • Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/

          • In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.

          • IPAM will not manage the IP addresses in accounts in the child OU.

        • Example 2

          • Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*

          • In this example, IPAM will not manage the IP addresses in accounts in the OU (ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.

        For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

        Parameters:
        organizationsEntityPath - An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.

        • Example 1

          • Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/

          • In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.

          • IPAM will not manage the IP addresses in accounts in the child OU.

        • Example 2

          • Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*

          • In this example, IPAM will not manage the IP addresses in accounts in the OU ( ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.

        For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

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