Class: Aws::VPCLattice::Types::CreateResourceConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::VPCLattice::Types::CreateResourceConfigurationRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_association_to_shareable_service_network ⇒ Boolean

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

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #custom_domain_name ⇒ String

  A custom domain name for your resource configuration.

• #domain_verification_identifier ⇒ String

  The domain verification ID of your verified custom domain name.

• #group_domain ⇒ String

  (GROUP) The group domain for a group resource configuration.

• #name ⇒ String

  The name of the resource configuration.

• #port_ranges ⇒ Array<String>

  (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).

• #protocol ⇒ String

  (SINGLE, GROUP) The protocol accepted by the resource configuration.

• #resource_configuration_definition ⇒ Types::ResourceConfigurationDefinition

  Identifies the resource configuration in one of the following ways:.

• #resource_configuration_group_identifier ⇒ String

  (CHILD) The ID or ARN of the parent resource configuration of type GROUP.

• #resource_gateway_identifier ⇒ String

  (SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration.

• #tags ⇒ Hash<String,String>

  The tags for the resource configuration.

• #type ⇒ String

  The type of resource configuration.

Instance Attribute Details

#allow_association_to_shareable_service_network ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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.

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

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_domain_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain_verification_identifier ⇒ String

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:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#group_domain ⇒ String

(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:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#port_ranges ⇒ Array<String>

(SINGLE, GROUP, CHILD) The TCP 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).

Returns:

• (Array<String>)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

(SINGLE, GROUP) The protocol accepted by the resource configuration.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_configuration_definition ⇒ Types::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.

Returns:

• (Types::ResourceConfigurationDefinition)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_configuration_group_identifier ⇒ String

(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:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_gateway_identifier ⇒ String

(SINGLE, GROUP, ARN) 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.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags for the resource configuration.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 434

class CreateResourceConfigurationRequest < Struct.new(
  :name,
  :type,
  :port_ranges,
  :protocol,
  :resource_gateway_identifier,
  :resource_configuration_group_identifier,
  :resource_configuration_definition,
  :allow_association_to_shareable_service_network,
  :custom_domain_name,
  :group_domain,
  :domain_verification_identifier,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end