Interface CreateVpcConfigurationRequest.Builder

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

  • Method Details

    • knowledgeBaseId

      CreateVpcConfigurationRequest.Builder knowledgeBaseId(String knowledgeBaseId)

      The unique identifier of the knowledge base to associate this VPC configuration with.

      Parameters:
      knowledgeBaseId - The unique identifier of the knowledge base to associate this VPC configuration with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateVpcConfigurationRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      CreateVpcConfigurationRequest.Builder vpcId(String vpcId)

      The identifier of the VPC that the knowledge base connects through to reach the resource.

      Parameters:
      vpcId - The identifier of the VPC that the knowledge base connects through to reach the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateVpcConfigurationRequest.Builder subnetIds(Collection<String> subnetIds)

      The subnets, in the VPC identified by vpcId, that the knowledge base uses to connect to the resource.

      Parameters:
      subnetIds - The subnets, in the VPC identified by vpcId, that the knowledge base uses to connect to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateVpcConfigurationRequest.Builder subnetIds(String... subnetIds)

      The subnets, in the VPC identified by vpcId, that the knowledge base uses to connect to the resource.

      Parameters:
      subnetIds - The subnets, in the VPC identified by vpcId, that the knowledge base uses to connect to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTarget

      CreateVpcConfigurationRequest.Builder resourceTarget(String resourceTarget)

      The private IPv4 address or DNS name of the resource you want the knowledge base to reach. The target must be privately reachable from inside your VPC, such as an internal load balancer or a private IP. The following are not supported:

      • Internet-facing endpoints

      • Loopback addresses

      • Link-local addresses

      • Wildcard addresses

      • Multicast addresses

      • IPv6 literals

      Parameters:
      resourceTarget - The private IPv4 address or DNS name of the resource you want the knowledge base to reach. The target must be privately reachable from inside your VPC, such as an internal load balancer or a private IP. The following are not supported:

      • Internet-facing endpoints

      • Loopback addresses

      • Link-local addresses

      • Wildcard addresses

      • Multicast addresses

      • IPv6 literals

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

    • port

      CreateVpcConfigurationRequest.Builder port(Integer port)

      The port on which to reach the resource.

      Parameters:
      port - The port on which to reach the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      CreateVpcConfigurationRequest.Builder protocol(String protocol)

      The protocol used to connect to the resource. Specify HTTP for plaintext or HTTPS for TLS. When you specify HTTPS, you must also provide tlsServerName.

      Parameters:
      protocol - The protocol used to connect to the resource. Specify HTTP for plaintext or HTTPS for TLS. When you specify HTTPS, you must also provide tlsServerName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      CreateVpcConfigurationRequest.Builder protocol(VpcProtocol protocol)

      The protocol used to connect to the resource. Specify HTTP for plaintext or HTTPS for TLS. When you specify HTTPS, you must also provide tlsServerName.

      Parameters:
      protocol - The protocol used to connect to the resource. Specify HTTP for plaintext or HTTPS for TLS. When you specify HTTPS, you must also provide tlsServerName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resolutionMode

      CreateVpcConfigurationRequest.Builder resolutionMode(String resolutionMode)

      Controls how a domain-name resourceTarget is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:

      • IN_VPC (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.

      • PUBLIC – The target domain name is resolved against public DNS resolvers. Select this only when the target's domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use IN_VPC.

      Parameters:
      resolutionMode - Controls how a domain-name resourceTarget is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:

      • IN_VPC (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.

      • PUBLIC – The target domain name is resolved against public DNS resolvers. Select this only when the target's domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use IN_VPC.

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

    • resolutionMode

      CreateVpcConfigurationRequest.Builder resolutionMode(VpcResolutionMode resolutionMode)

      Controls how a domain-name resourceTarget is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:

      • IN_VPC (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.

      • PUBLIC – The target domain name is resolved against public DNS resolvers. Select this only when the target's domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use IN_VPC.

      Parameters:
      resolutionMode - Controls how a domain-name resourceTarget is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:

      • IN_VPC (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.

      • PUBLIC – The target domain name is resolved against public DNS resolvers. Select this only when the target's domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use IN_VPC.

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

    • hostHeader

      CreateVpcConfigurationRequest.Builder hostHeader(String hostHeader)

      An optional HTTP Host header value to send when invoking the resource. Set this only if your resource (or an upstream router or ingress) routes by the Host header and that host differs from the target. This setting is independent of tlsServerName.

      Parameters:
      hostHeader - An optional HTTP Host header value to send when invoking the resource. Set this only if your resource (or an upstream router or ingress) routes by the Host header and that host differs from the target. This setting is independent of tlsServerName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tlsServerName

      CreateVpcConfigurationRequest.Builder tlsServerName(String tlsServerName)

      The expected TLS server name. The service matches this value against the Subject Alternative Names on your resource's TLS certificate during invocation. This field is required when protocol is HTTPS. Set it to a hostname on your certificate, such as app.internal.example.com. You can use a single leftmost wildcard, such as *.example.com. The value must be a hostname without a port.

      Parameters:
      tlsServerName - The expected TLS server name. The service matches this value against the Subject Alternative Names on your resource's TLS certificate during invocation. This field is required when protocol is HTTPS. Set it to a hostname on your certificate, such as app.internal.example.com. You can use a single leftmost wildcard, such as *.example.com. The value must be a hostname without a port.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateVpcConfigurationRequest.Builder name(String name)

      An optional human-readable name for the VPC configuration. If you don't specify a name, the VPC configuration has no name.

      Parameters:
      name - An optional human-readable name for the VPC configuration. If you don't specify a name, the VPC configuration has no name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateVpcConfigurationRequest.Builder description(String description)

      An optional description of the VPC configuration. If you don't specify a description, the VPC configuration has no description.

      Parameters:
      description - An optional description of the VPC configuration. If you don't specify a description, the VPC configuration has no description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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