public static interface Target.Builder extends CopyableBuilder<Target.Builder,Target>
Modifier and Type | Method and Description |
---|---|
Target.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the target.
|
default Target.Builder |
ecsParameters(Consumer<EcsParameters.Builder> ecsParameters)
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
|
Target.Builder |
ecsParameters(EcsParameters ecsParameters)
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
|
Target.Builder |
id(String id)
The ID of the target.
|
Target.Builder |
input(String input)
Valid JSON text passed to the target.
|
Target.Builder |
inputPath(String inputPath)
The value of the JSONPath that is used for extracting part of the matched event when passing it to the
target.
|
default Target.Builder |
inputTransformer(Consumer<InputTransformer.Builder> inputTransformer)
Settings to enable you to provide custom input to a target based on certain event data.
|
Target.Builder |
inputTransformer(InputTransformer inputTransformer)
Settings to enable you to provide custom input to a target based on certain event data.
|
default Target.Builder |
kinesisParameters(Consumer<KinesisParameters.Builder> kinesisParameters)
The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream.
|
Target.Builder |
kinesisParameters(KinesisParameters kinesisParameters)
The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream.
|
Target.Builder |
roleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
|
default Target.Builder |
runCommandParameters(Consumer<RunCommandParameters.Builder> runCommandParameters)
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
|
Target.Builder |
runCommandParameters(RunCommandParameters runCommandParameters)
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
|
copy
applyMutation, build
Target.Builder id(String id)
The ID of the target.
id
- The ID of the target.Target.Builder arn(String arn)
The Amazon Resource Name (ARN) of the target.
arn
- The Amazon Resource Name (ARN) of the target.Target.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
roleArn
- The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
If one rule triggers multiple targets, you can use a different IAM role for each target.Target.Builder input(String input)
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. You must use JSON dot notation, not bracket notation. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
input
- Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the
target. You must use JSON dot notation, not bracket notation. For more information, see The JavaScript Object Notation (JSON) Data
Interchange Format.Target.Builder inputPath(String inputPath)
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
inputPath
- The value of the JSONPath that is used for extracting part of the matched event when passing it to the
target. You must use JSON dot notation, not bracket notation. For more information about JSON paths,
see JSONPath.Target.Builder inputTransformer(InputTransformer inputTransformer)
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
inputTransformer
- Settings to enable you to provide custom input to a target based on certain event data. You can
extract one or more key-value pairs from the event and then use that data to send customized input to
the target.default Target.Builder inputTransformer(Consumer<InputTransformer.Builder> inputTransformer)
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
This is a convenience that creates an instance of theInputTransformer.Builder
avoiding the need to
create one manually via InputTransformer.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to inputTransformer(InputTransformer)
.inputTransformer
- a consumer that will call methods on InputTransformer.Builder
inputTransformer(InputTransformer)
Target.Builder kinesisParameters(KinesisParameters kinesisParameters)
The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If
you do not include this parameter, the default is to use the eventId
as the partition key.
kinesisParameters
- The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis
stream. If you do not include this parameter, the default is to use the eventId
as the
partition key.default Target.Builder kinesisParameters(Consumer<KinesisParameters.Builder> kinesisParameters)
The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If
you do not include this parameter, the default is to use the eventId
as the partition key.
KinesisParameters.Builder
avoiding the need to
create one manually via KinesisParameters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to kinesisParameters(KinesisParameters)
.kinesisParameters
- a consumer that will call methods on KinesisParameters.Builder
kinesisParameters(KinesisParameters)
Target.Builder runCommandParameters(RunCommandParameters runCommandParameters)
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
runCommandParameters
- Parameters used when you are using the rule to invoke Amazon EC2 Run Command.default Target.Builder runCommandParameters(Consumer<RunCommandParameters.Builder> runCommandParameters)
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
This is a convenience that creates an instance of theRunCommandParameters.Builder
avoiding the need
to create one manually via RunCommandParameters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to runCommandParameters(RunCommandParameters)
.runCommandParameters
- a consumer that will call methods on RunCommandParameters.Builder
runCommandParameters(RunCommandParameters)
Target.Builder ecsParameters(EcsParameters ecsParameters)
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
ecsParameters
- Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon
ECS task. For more information about Amazon ECS tasks, see Task
Definitions in the Amazon EC2 Container Service Developer Guide.default Target.Builder ecsParameters(Consumer<EcsParameters.Builder> ecsParameters)
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
This is a convenience that creates an instance of theEcsParameters.Builder
avoiding the need to
create one manually via EcsParameters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to ecsParameters(EcsParameters)
.ecsParameters
- a consumer that will call methods on EcsParameters.Builder
ecsParameters(EcsParameters)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.