Interface Ipam.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Ipam.Builder,Ipam>,SdkBuilder<Ipam.Builder,Ipam>,SdkPojo
- Enclosing class:
- Ipam
public static interface Ipam.Builder extends SdkPojo, CopyableBuilder<Ipam.Builder,Ipam>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Ipam.BuilderdefaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)The IPAM's default resource discovery association ID.Ipam.BuilderdefaultResourceDiscoveryId(String defaultResourceDiscoveryId)The IPAM's default resource discovery ID.Ipam.Builderdescription(String description)The description for the IPAM.Ipam.BuilderenablePrivateGua(Boolean enablePrivateGua)Enable this option to use your own GUA ranges as private IPv6 addresses.Ipam.BuilderipamArn(String ipamArn)The Amazon Resource Name (ARN) of the IPAM.Ipam.BuilderipamId(String ipamId)The ID of the IPAM.Ipam.BuilderipamRegion(String ipamRegion)The Amazon Web Services Region of the IPAM.Ipam.BuilderoperatingRegions(Collection<IpamOperatingRegion> operatingRegions)The operating Regions for an IPAM.Ipam.BuilderoperatingRegions(Consumer<IpamOperatingRegion.Builder>... operatingRegions)The operating Regions for an IPAM.Ipam.BuilderoperatingRegions(IpamOperatingRegion... operatingRegions)The operating Regions for an IPAM.Ipam.BuilderownerId(String ownerId)The Amazon Web Services account ID of the owner of the IPAM.Ipam.BuilderprivateDefaultScopeId(String privateDefaultScopeId)The ID of the IPAM's default private scope.Ipam.BuilderpublicDefaultScopeId(String publicDefaultScopeId)The ID of the IPAM's default public scope.Ipam.BuilderresourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)The IPAM's resource discovery association count.Ipam.BuilderscopeCount(Integer scopeCount)The number of scopes in the IPAM.Ipam.Builderstate(String state)The state of the IPAM.Ipam.Builderstate(IpamState state)The state of the IPAM.Ipam.BuilderstateMessage(String stateMessage)The state message.Ipam.Buildertags(Collection<Tag> tags)The key/value combination of a tag assigned to the resource.Ipam.Buildertags(Consumer<Tag.Builder>... tags)The key/value combination of a tag assigned to the resource.Ipam.Buildertags(Tag... tags)The key/value combination of a tag assigned to the resource.Ipam.Buildertier(String tier)IPAM is offered in a Free Tier and an Advanced Tier.Ipam.Buildertier(IpamTier tier)IPAM is offered in a Free Tier and an Advanced Tier.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
ownerId
Ipam.Builder ownerId(String ownerId)
The Amazon Web Services account ID of the owner of the IPAM.
- Parameters:
ownerId- The Amazon Web Services account ID of the owner of the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamId
Ipam.Builder ipamId(String ipamId)
The ID of the IPAM.
- Parameters:
ipamId- The ID of the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamArn
Ipam.Builder ipamArn(String ipamArn)
The Amazon Resource Name (ARN) of the IPAM.
- Parameters:
ipamArn- The Amazon Resource Name (ARN) of the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamRegion
Ipam.Builder ipamRegion(String ipamRegion)
The Amazon Web Services Region of the IPAM.
- Parameters:
ipamRegion- The Amazon Web Services Region of the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicDefaultScopeId
Ipam.Builder publicDefaultScopeId(String publicDefaultScopeId)
The ID of the IPAM's default public scope.
- Parameters:
publicDefaultScopeId- The ID of the IPAM's default public scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privateDefaultScopeId
Ipam.Builder privateDefaultScopeId(String privateDefaultScopeId)
The ID of the IPAM's default private scope.
- Parameters:
privateDefaultScopeId- The ID of the IPAM's default private scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scopeCount
Ipam.Builder scopeCount(Integer scopeCount)
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
- Parameters:
scopeCount- The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Ipam.Builder description(String description)
The description for the IPAM.
- Parameters:
description- The description for the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operatingRegions
Ipam.Builder operatingRegions(Collection<IpamOperatingRegion> operatingRegions)
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- Parameters:
operatingRegions- The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operatingRegions
Ipam.Builder operatingRegions(IpamOperatingRegion... operatingRegions)
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- Parameters:
operatingRegions- The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operatingRegions
Ipam.Builder operatingRegions(Consumer<IpamOperatingRegion.Builder>... operatingRegions)
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
This is a convenience method that creates an instance of theIpamOperatingRegion.Builderavoiding the need to create one manually viaIpamOperatingRegion.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#operatingRegions(List.) - Parameters:
operatingRegions- a consumer that will call methods onIpamOperatingRegion.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#operatingRegions(java.util.Collection)
-
state
Ipam.Builder state(String state)
The state of the IPAM.
-
state
Ipam.Builder state(IpamState state)
The state of the IPAM.
-
tags
Ipam.Builder tags(Collection<Tag> tags)
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.- Parameters:
tags- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Ipam.Builder tags(Tag... tags)
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.- Parameters:
tags- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Ipam.Builder tags(Consumer<Tag.Builder>... tags)
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key
This is a convenience method that creates an instance of theOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.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)
-
defaultResourceDiscoveryId
Ipam.Builder defaultResourceDiscoveryId(String defaultResourceDiscoveryId)
The IPAM's default resource discovery ID.
- Parameters:
defaultResourceDiscoveryId- The IPAM's default resource discovery ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultResourceDiscoveryAssociationId
Ipam.Builder defaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)
The IPAM's default resource discovery association ID.
- Parameters:
defaultResourceDiscoveryAssociationId- The IPAM's default resource discovery association ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceDiscoveryAssociationCount
Ipam.Builder resourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)
The IPAM's resource discovery association count.
- Parameters:
resourceDiscoveryAssociationCount- The IPAM's resource discovery association count.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateMessage
Ipam.Builder stateMessage(String stateMessage)
The state message.
- Parameters:
stateMessage- The state message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tier
Ipam.Builder tier(String tier)
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
- Parameters:
tier- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpamTier,IpamTier
-
tier
Ipam.Builder tier(IpamTier tier)
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
- Parameters:
tier- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IpamTier,IpamTier
-
enablePrivateGua
Ipam.Builder enablePrivateGua(Boolean enablePrivateGua)
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
- Parameters:
enablePrivateGua- Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-