java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CreateIpamRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateIpamRequest.Builder,CreateIpamRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateIpamRequest
extends Ec2Request
implements ToCopyableBuilder<CreateIpamRequest.Builder,CreateIpamRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateIpamRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateIpamRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`description()`	A description for the IPAM.
`Boolean`	`dryRun()`	A check for whether you have the required permissions for the action without actually making the request and provides an error response.
`Boolean`	`enablePrivateGua()`	Enable this option to use your own GUA ranges as private IPv6 addresses.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOperatingRegions()`	For responses, this returns true if the service returned a value for the OperatingRegions property.
`boolean`	`hasTagSpecifications()`	For responses, this returns true if the service returned a value for the TagSpecifications property.
`IpamMeteredAccount`	`meteredAccount()`	A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM.
`String`	`meteredAccountAsString()`	A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM.
`List<AddIpamOperatingRegion>`	`operatingRegions()`	The operating Regions for the IPAM.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateIpamRequest.Builder>`	`serializableBuilderClass()`
`List<TagSpecification>`	`tagSpecifications()`	The key/value combination of a tag assigned to the resource.
`IpamTier`	`tier()`	IPAM is offered in a Free Tier and an Advanced Tier.
`String`	`tierAsString()`	IPAM is offered in a Free Tier and an Advanced Tier.
`CreateIpamRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - dryRun
```
public final Boolean 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 is UnauthorizedOperation.
    
    Returns:
    
    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 is UnauthorizedOperation.
  - description
```
public final String description()
```
    A description for the IPAM.
    
    Returns:
    
    A description for the IPAM.
  - hasOperatingRegions
```
public final boolean hasOperatingRegions()
```
    For responses, this returns true if the service returned a value for the OperatingRegions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - operatingRegions
```
public final List<AddIpamOperatingRegion> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperatingRegions() method.
    
    Returns:
    
    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.
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagSpecifications
```
public final List<TagSpecification> 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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.
    
    Returns:
    
    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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  - clientToken
```
public final String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
  - tier
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, tier will return IpamTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    IpamTier
  - tierAsString
```
public final String tierAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, tier will return IpamTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    IpamTier
  - enablePrivateGua
```
public final Boolean enablePrivateGua()
```
    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
    
    Returns:
    
    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
  - meteredAccount
```
public final IpamMeteredAccount meteredAccount()
```
    A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
    
    Possible values:
    
    ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
    
    resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    
    If the service returns an enum value that is not available in the current SDK version, meteredAccount will return IpamMeteredAccount.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from meteredAccountAsString().
    Returns:
    
    A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
    
    Possible values:
    
    ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
    
    resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    
    See Also:
    
    IpamMeteredAccount
  - meteredAccountAsString
```
public final String meteredAccountAsString()
```
    A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
    
    Possible values:
    
    ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
    
    resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    
    If the service returns an enum value that is not available in the current SDK version, meteredAccount will return IpamMeteredAccount.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from meteredAccountAsString().
    Returns:
    
    A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
    
    Possible values:
    
    ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
    
    resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
    
    See Also:
    
    IpamMeteredAccount
  - toBuilder
```
public CreateIpamRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateIpamRequest.Builder,CreateIpamRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateIpamRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateIpamRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateIpamRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dryRun

description

hasOperatingRegions

operatingRegions

hasTagSpecifications

tagSpecifications

clientToken

tier

tierAsString

enablePrivateGua

meteredAccount

meteredAccountAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField