Class: Aws::VPCLattice::Types::CreateListenerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_actionTypes::RuleAction

The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forwardor fixed-response, and it must be the last action to be performed.

Returns:



250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the listener. A listener name must be unique within a service. 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)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

Returns:

  • (Integer)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

The listener protocol HTTP or HTTPS.

Returns:

  • (String)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_identifierString

The ID or Amazon Resource Name (ARN) of the service.

Returns:

  • (String)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags for the listener.

Returns:

  • (Hash<String,String>)


250
251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-vpclattice/lib/aws-sdk-vpclattice/types.rb', line 250

class CreateListenerRequest < Struct.new(
  :client_token,
  :default_action,
  :name,
  :port,
  :protocol,
  :service_identifier,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end