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

Interface ModifyIpamScopeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyIpamScopeRequest.Builder,ModifyIpamScopeRequest>, Ec2Request.Builder, SdkBuilder<ModifyIpamScopeRequest.Builder,ModifyIpamScopeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyIpamScopeRequest

@Mutable
@NotThreadSafe
public static interface ModifyIpamScopeRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyIpamScopeRequest.Builder,ModifyIpamScopeRequest>

Method Summary

Modifier and Type	Method	Description
ModifyIpamScopeRequest.Builder	description(String description)	The description of the scope you want to modify.
ModifyIpamScopeRequest.Builder	dryRun(Boolean dryRun)	A check for whether you have the required permissions for the action without actually making the request and provides an error response.
default ModifyIpamScopeRequest.Builder	externalAuthorityConfiguration(Consumer<ExternalAuthorityConfiguration.Builder> externalAuthorityConfiguration)	The configuration that links an Amazon VPC IPAM scope to an external authority system.
ModifyIpamScopeRequest.Builder	externalAuthorityConfiguration(ExternalAuthorityConfiguration externalAuthorityConfiguration)	The configuration that links an Amazon VPC IPAM scope to an external authority system.
ModifyIpamScopeRequest.Builder	ipamScopeId(String ipamScopeId)	The ID of the scope you want to modify.
ModifyIpamScopeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ModifyIpamScopeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ModifyIpamScopeRequest.Builder	removeExternalAuthorityConfiguration(Boolean removeExternalAuthorityConfiguration)	Remove the external authority configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

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

dryRun

ModifyIpamScopeRequest.Builder dryRun(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.

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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipamScopeId

ModifyIpamScopeRequest.Builder ipamScopeId(String ipamScopeId)

The ID of the scope you want to modify.

Parameters:

ipamScopeId - The ID of the scope you want to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ModifyIpamScopeRequest.Builder description(String description)

The description of the scope you want to modify.

Parameters:

description - The description of the scope you want to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

externalAuthorityConfiguration

ModifyIpamScopeRequest.Builder externalAuthorityConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

externalAuthorityConfiguration

default ModifyIpamScopeRequest.Builder externalAuthorityConfiguration(Consumer<ExternalAuthorityConfiguration.Builder> 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.

This is a convenience method that creates an instance of the ExternalAuthorityConfiguration.Builder avoiding the need to create one manually via ExternalAuthorityConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to externalAuthorityConfiguration(ExternalAuthorityConfiguration).

Parameters:

externalAuthorityConfiguration - a consumer that will call methods on ExternalAuthorityConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

externalAuthorityConfiguration(ExternalAuthorityConfiguration)

removeExternalAuthorityConfiguration

ModifyIpamScopeRequest.Builder removeExternalAuthorityConfiguration(Boolean removeExternalAuthorityConfiguration)

Remove the external authority configuration. true to remove.

Parameters:

removeExternalAuthorityConfiguration - Remove the external authority configuration. true to remove.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ModifyIpamScopeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ModifyIpamScopeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder