Class: Aws::BedrockAgent::Types::CreateVpcConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::CreateVpcConfigurationRequest

Defined in:

gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the operation completes no more than one time.

• #description ⇒ String

  An optional description of the VPC configuration.

• #host_header ⇒ String

  An optional HTTP Host header value to send when invoking the resource.

• #knowledge_base_id ⇒ String

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

• #name ⇒ String

  An optional human-readable name for the VPC configuration.

• #port ⇒ Integer

  The port on which to reach the resource.

• #protocol ⇒ String

  The protocol used to connect to the resource.

• #resolution_mode ⇒ String

  Controls how a domain-name resourceTarget is resolved.

• #resource_target ⇒ String

  The private IPv4 address or DNS name of the resource you want the knowledge base to reach.

• #subnet_ids ⇒ Array<String>

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

• #tls_server_name ⇒ String

  The expected TLS server name.

• #vpc_id ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#host_header ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port on which to reach the resource.

Returns:

• (Integer)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#resolution_mode ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#resource_target ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#tls_server_name ⇒ String

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:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3126

class CreateVpcConfigurationRequest < Struct.new(
  :knowledge_base_id,
  :client_token,
  :vpc_id,
  :subnet_ids,
  :resource_target,
  :port,
  :protocol,
  :resolution_mode,
  :host_header,
  :tls_server_name,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end