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

Interface CreateIpamScopeRequest.Builder

    • Method Detail

      • dryRun

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

      • ipamId

        CreateIpamScopeRequest.Builder ipamId​(String ipamId)

        The ID of the IPAM for which you're creating this scope.

        Parameters:
        ipamId - The ID of the IPAM for which you're creating this scope.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateIpamScopeRequest.Builder description​(String description)

        A description for the scope you're creating.

        Parameters:
        description - A description for the scope you're creating.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagSpecifications

        CreateIpamScopeRequest.Builder tagSpecifications​(Collection<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.

        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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagSpecifications

        CreateIpamScopeRequest.Builder tagSpecifications​(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.

        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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagSpecifications

        CreateIpamScopeRequest.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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagSpecifications(List).

        Parameters:
        tagSpecifications - a consumer that will call methods on TagSpecification.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tagSpecifications(java.util.Collection)

      • clientToken

        CreateIpamScopeRequest.Builder clientToken​(String 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.

      • externalAuthorityConfiguration

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