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

Class ModifyIpamScopeRequest

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.ModifyIpamScopeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyIpamScopeRequest.Builder,ModifyIpamScopeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyIpamScopeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifyIpamScopeRequest.Builder	builder()
String	description()	The description of the scope you want to modify.
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	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExternalAuthorityConfiguration	externalAuthorityConfiguration()	The configuration that links an Amazon VPC IPAM scope to an external authority system.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ipamScopeId()	The ID of the scope you want to modify.
Boolean	removeExternalAuthorityConfiguration()	Remove the external authority configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyIpamScopeRequest.Builder>	serializableBuilderClass()
ModifyIpamScopeRequest.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.

ipamScopeId

public final String ipamScopeId()

The ID of the scope you want to modify.

Returns:

The ID of the scope you want to modify.

description

public final String description()

The description of the scope you want to modify.

Returns:

The description of the scope you want to modify.

externalAuthorityConfiguration

public final ExternalAuthorityConfiguration externalAuthorityConfiguration()

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

Returns:

The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

removeExternalAuthorityConfiguration

public final Boolean removeExternalAuthorityConfiguration()

Remove the external authority configuration. true to remove.

Returns:

Remove the external authority configuration. true to remove.

toBuilder

public ModifyIpamScopeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyIpamScopeRequest.Builder,ModifyIpamScopeRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyIpamScopeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyIpamScopeRequest.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