Class AddIpamOrganizationalUnitExclusion
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.AddIpamOrganizationalUnitExclusion
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AddIpamOrganizationalUnitExclusion.Builder,AddIpamOrganizationalUnitExclusion>
@Generated("software.amazon.awssdk:codegen") public final class AddIpamOrganizationalUnitExclusion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AddIpamOrganizationalUnitExclusion.Builder,AddIpamOrganizationalUnitExclusion>
Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AddIpamOrganizationalUnitExclusion.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AddIpamOrganizationalUnitExclusion.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
organizationsEntityPath()
An Amazon Web Services Organizations entity path.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends AddIpamOrganizationalUnitExclusion.Builder>
serializableBuilderClass()
AddIpamOrganizationalUnitExclusion.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
organizationsEntityPath
public final 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, andou-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:
- 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, andou-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.
-
-
-
toBuilder
public AddIpamOrganizationalUnitExclusion.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AddIpamOrganizationalUnitExclusion.Builder,AddIpamOrganizationalUnitExclusion>
-
builder
public static AddIpamOrganizationalUnitExclusion.Builder builder()
-
serializableBuilderClass
public static Class<? extends AddIpamOrganizationalUnitExclusion.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-