Interface CreateIpamRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateIpamRequest.Builder,,CreateIpamRequest> Ec2Request.Builder,SdkBuilder<CreateIpamRequest.Builder,,CreateIpamRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateIpamRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.description(String description) A description for the IPAM.A check for whether you have the required permissions for the action without actually making the request and provides an error response.enablePrivateGua(Boolean enablePrivateGua) Enable this option to use your own GUA ranges as private IPv6 addresses.operatingRegions(Collection<AddIpamOperatingRegion> operatingRegions) The operating Regions for the IPAM.operatingRegions(Consumer<AddIpamOperatingRegion.Builder>... operatingRegions) The operating Regions for the IPAM.operatingRegions(AddIpamOperatingRegion... operatingRegions) The operating Regions for the IPAM.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tagSpecifications(Collection<TagSpecification> tagSpecifications) The key/value combination of a tag assigned to the resource.tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The key/value combination of a tag assigned to the resource.tagSpecifications(TagSpecification... tagSpecifications) The key/value combination of a tag assigned to the resource.IPAM is offered in a Free Tier and an Advanced Tier.IPAM is offered in a Free Tier and an Advanced Tier.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dryRun
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.- Parameters:
dryRun- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it isUnauthorizedOperation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description for the IPAM.
- Parameters:
description- A description for the IPAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operatingRegions
The operating Regions for the 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 the 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
The operating Regions for the 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 the 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
CreateIpamRequest.Builder operatingRegions(Consumer<AddIpamOperatingRegion.Builder>... operatingRegions) The operating Regions for the 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 theAddIpamOperatingRegion.Builderavoiding the need to create one manually viaAddIpamOperatingRegion.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooperatingRegions(List<AddIpamOperatingRegion>).- Parameters:
operatingRegions- a consumer that will call methods onAddIpamOperatingRegion.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tagSpecifications
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:
tagSpecifications- 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.
-
tagSpecifications
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:
tagSpecifications- 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.
-
tagSpecifications
CreateIpamRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) 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.TagSpecification.Builderavoiding the need to create one manually viaTagSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totagSpecifications(List<TagSpecification>).- Parameters:
tagSpecifications- a consumer that will call methods onTagSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
- Parameters:
clientToken- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
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:
-
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.
-
overrideConfiguration
CreateIpamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateIpamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-