Interface CreateResourceConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateResourceConfigurationRequest.Builder,CreateResourceConfigurationRequest>, SdkBuilder<CreateResourceConfigurationRequest.Builder,CreateResourceConfigurationRequest>, SdkPojo, SdkRequest.Builder, VpcLatticeRequest.Builder
Enclosing class:
CreateResourceConfigurationRequest
@Mutable @NotThreadSafe public static interface CreateResourceConfigurationRequest.Builder extends VpcLatticeRequest.Builder, SdkPojo, CopyableBuilder<CreateResourceConfigurationRequest.Builder,CreateResourceConfigurationRequest>

  • Method Details

    • name

      CreateResourceConfigurationRequest.Builder name(String name)

      The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

      Parameters:
      name - The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateResourceConfigurationRequest.Builder type(String type)

      The type of resource configuration. A resource configuration can be one of the following types:

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      • CIDR - A network segment, expressed as a range of IP addresses (a CIDR block). Use this type to share a portion of your network rather than an individual resource. A consumer accesses the resources within the CIDR range through a Tunnel VPC endpoint. You can't add a CIDR resource configuration to a service network. A CIDR resource configuration must be associated with a resource gateway whose DNS resolution is set to IN_VPC.

      Parameters:
      type - The type of resource configuration. A resource configuration can be one of the following types:

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      • CIDR - A network segment, expressed as a range of IP addresses (a CIDR block). Use this type to share a portion of your network rather than an individual resource. A consumer accesses the resources within the CIDR range through a Tunnel VPC endpoint. You can't add a CIDR resource configuration to a service network. A CIDR resource configuration must be associated with a resource gateway whose DNS resolution is set to IN_VPC.

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

    • type

      CreateResourceConfigurationRequest.Builder type(ResourceConfigurationType type)

      The type of resource configuration. A resource configuration can be one of the following types:

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      • CIDR - A network segment, expressed as a range of IP addresses (a CIDR block). Use this type to share a portion of your network rather than an individual resource. A consumer accesses the resources within the CIDR range through a Tunnel VPC endpoint. You can't add a CIDR resource configuration to a service network. A CIDR resource configuration must be associated with a resource gateway whose DNS resolution is set to IN_VPC.

      Parameters:
      type - The type of resource configuration. A resource configuration can be one of the following types:

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      • CIDR - A network segment, expressed as a range of IP addresses (a CIDR block). Use this type to share a portion of your network rather than an individual resource. A consumer accesses the resources within the CIDR range through a Tunnel VPC endpoint. You can't add a CIDR resource configuration to a service network. A CIDR resource configuration must be associated with a resource gateway whose DNS resolution is set to IN_VPC.

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

    • portRanges

      CreateResourceConfigurationRequest.Builder portRanges(Collection<String> portRanges)

      (SINGLE, GROUP, CHILD, CIDR) The port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). To resolve DNS through a CIDR resource configuration, include port 53 in the port ranges.

      Parameters:
      portRanges - (SINGLE, GROUP, CHILD, CIDR) The port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). To resolve DNS through a CIDR resource configuration, include port 53 in the port ranges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portRanges

      CreateResourceConfigurationRequest.Builder portRanges(String... portRanges)

      (SINGLE, GROUP, CHILD, CIDR) The port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). To resolve DNS through a CIDR resource configuration, include port 53 in the port ranges.

      Parameters:
      portRanges - (SINGLE, GROUP, CHILD, CIDR) The port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). To resolve DNS through a CIDR resource configuration, include port 53 in the port ranges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      CreateResourceConfigurationRequest.Builder protocol(String protocol)

      (SINGLE, GROUP, CIDR) The protocol accepted by the resource configuration. The default is TCP. TCP_UDP is supported only for CIDR resource configurations; specify it for a CIDR resource configuration to allow DNS resolution, which uses UDP.

      Parameters:
      protocol - (SINGLE, GROUP, CIDR) The protocol accepted by the resource configuration. The default is TCP. TCP_UDP is supported only for CIDR resource configurations; specify it for a CIDR resource configuration to allow DNS resolution, which uses UDP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      CreateResourceConfigurationRequest.Builder protocol(ProtocolType protocol)

      (SINGLE, GROUP, CIDR) The protocol accepted by the resource configuration. The default is TCP. TCP_UDP is supported only for CIDR resource configurations; specify it for a CIDR resource configuration to allow DNS resolution, which uses UDP.

      Parameters:
      protocol - (SINGLE, GROUP, CIDR) The protocol accepted by the resource configuration. The default is TCP. TCP_UDP is supported only for CIDR resource configurations; specify it for a CIDR resource configuration to allow DNS resolution, which uses UDP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceGatewayIdentifier

      CreateResourceConfigurationRequest.Builder resourceGatewayIdentifier(String resourceGatewayIdentifier)

      (SINGLE, GROUP, ARN, CIDR) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration. For a CIDR resource configuration, the associated resource gateway must have its DNS resolution set to IN_VPC so that DNS queries resolve in the context of your VPC.

      Parameters:
      resourceGatewayIdentifier - (SINGLE, GROUP, ARN, CIDR) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration. For a CIDR resource configuration, the associated resource gateway must have its DNS resolution set to IN_VPC so that DNS queries resolve in the context of your VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceConfigurationGroupIdentifier

      CreateResourceConfigurationRequest.Builder resourceConfigurationGroupIdentifier(String resourceConfigurationGroupIdentifier)

      (CHILD) The ID or ARN of the parent resource configuration of type GROUP. This is used to associate a child resource configuration with a group resource configuration.

      Parameters:
      resourceConfigurationGroupIdentifier - (CHILD) The ID or ARN of the parent resource configuration of type GROUP. This is used to associate a child resource configuration with a group resource configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceConfigurationDefinition

      CreateResourceConfigurationRequest.Builder resourceConfigurationDefinition(ResourceConfigurationDefinition resourceConfigurationDefinition)

      Identifies the resource configuration in one of the following ways:

      • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

      • Domain name - Any domain name that is publicly resolvable.

      • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

      • CIDR range - For a resource configuration of type CIDR, specify a cidrResource with one or more cidrRanges (for example, 10.0.0.0/16) that cover the IP addresses of the resources you want to make accessible. You can specify up to 10 ranges, using IPv4, IPv6, or both, and each range must include a prefix length. To represent your entire network, specify 0.0.0.0/0 (IPv4) or ::/0 (IPv6) as the only range. You can't use reserved ranges such as 169.254.0.0/16, 100.64.0.0/10, 224.0.0.0/4, fe80::/10, or ff00::/8.

      Parameters:
      resourceConfigurationDefinition - Identifies the resource configuration in one of the following ways:

      • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

      • Domain name - Any domain name that is publicly resolvable.

      • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

      • CIDR range - For a resource configuration of type CIDR, specify a cidrResource with one or more cidrRanges (for example, 10.0.0.0/16) that cover the IP addresses of the resources you want to make accessible. You can specify up to 10 ranges, using IPv4, IPv6, or both, and each range must include a prefix length. To represent your entire network, specify 0.0.0.0/0 (IPv4) or ::/0 (IPv6) as the only range. You can't use reserved ranges such as 169.254.0.0/16, 100.64.0.0/10, 224.0.0.0/4, fe80::/10, or ff00::/8.

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

    • resourceConfigurationDefinition

      default CreateResourceConfigurationRequest.Builder resourceConfigurationDefinition(Consumer<ResourceConfigurationDefinition.Builder> resourceConfigurationDefinition)

      Identifies the resource configuration in one of the following ways:

      • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

      • Domain name - Any domain name that is publicly resolvable.

      • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

      • CIDR range - For a resource configuration of type CIDR, specify a cidrResource with one or more cidrRanges (for example, 10.0.0.0/16) that cover the IP addresses of the resources you want to make accessible. You can specify up to 10 ranges, using IPv4, IPv6, or both, and each range must include a prefix length. To represent your entire network, specify 0.0.0.0/0 (IPv4) or ::/0 (IPv6) as the only range. You can't use reserved ranges such as 169.254.0.0/16, 100.64.0.0/10, 224.0.0.0/4, fe80::/10, or ff00::/8.

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

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

      Parameters:
      resourceConfigurationDefinition - a consumer that will call methods on ResourceConfigurationDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowAssociationToShareableServiceNetwork

      CreateResourceConfigurationRequest.Builder allowAssociationToShareableServiceNetwork(Boolean allowAssociationToShareableServiceNetwork)

      (SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.

      Parameters:
      allowAssociationToShareableServiceNetwork - (SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainName

      CreateResourceConfigurationRequest.Builder customDomainName(String customDomainName)

      A custom domain name for your resource configuration. Additionally, provide a DomainVerificationID to prove your ownership of a domain.

      Parameters:
      customDomainName - A custom domain name for your resource configuration. Additionally, provide a DomainVerificationID to prove your ownership of a domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupDomain

      CreateResourceConfigurationRequest.Builder groupDomain(String groupDomain)

      (GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.

      Parameters:
      groupDomain - (GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainVerificationIdentifier

      CreateResourceConfigurationRequest.Builder domainVerificationIdentifier(String domainVerificationIdentifier)

      The domain verification ID of your verified custom domain name. If you don't provide an ID, you must configure the DNS settings yourself.

      Parameters:
      domainVerificationIdentifier - The domain verification ID of your verified custom domain name. If you don't provide an ID, you must configure the DNS settings yourself.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateResourceConfigurationRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateResourceConfigurationRequest.Builder tags(Map<String,String> tags)

      The tags for the resource configuration.

      Parameters:
      tags - The tags for the resource configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateResourceConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateResourceConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.