Class: Aws::RTBFabric::Types::FlowModule
- Inherits:
-
Struct
- Object
- Struct
- Aws::RTBFabric::Types::FlowModule
- Defined in:
- gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb
Overview
A version attached to a flow, with its settings.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#activation_percentage ⇒ Float
The percentage of the flow's requests that the module runs on.
-
#configuration_values ⇒ String
RTB Fabric validates the value against the version's
configurationSchemaand rejects a value that fails with ValidationException. -
#failure_mode ⇒ String
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale.
-
#module_version_arn ⇒ String
The version to attach.
-
#name ⇒ String
The module's name, unique within the flow.
-
#selected_actions ⇒ Array<String>
The capabilities to turn on, chosen from the version's
configurableActions.
Instance Attribute Details
#activation_percentage ⇒ Float
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |
#configuration_values ⇒ String
RTB Fabric validates the value against the version's
configurationSchema and rejects a value that fails with
ValidationException. Omit it when the schema is empty or fully
defaulted.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |
#failure_mode ⇒ String
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |
#module_version_arn ⇒ String
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The module's name, unique within the flow.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |
#selected_actions ⇒ Array<String>
The capabilities to turn on, chosen from the version's
configurableActions. If the version exposes one, it's the
default. If the version exposes more than one, this field is
required. If it exposes none, omit this field.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 |
# File 'gems/aws-sdk-rtbfabric/lib/aws-sdk-rtbfabric/types.rb', line 1381 class FlowModule < Struct.new( :name, :module_version_arn, :selected_actions, :failure_mode, :activation_percentage, :configuration_values) SENSITIVE = [] include Aws::Structure end |