public static final class RuleTargetConfig.Builder
extends java.lang.Object
RuleTargetConfig
Constructor and Description |
---|
Builder() |
public RuleTargetConfig.Builder arn(java.lang.String arn)
RuleTargetConfig.getArn()
arn
- The Amazon Resource Name (ARN) of the target. This parameter is required.this
public RuleTargetConfig.Builder batchParameters(CfnRule.BatchParametersProperty batchParameters)
RuleTargetConfig.getBatchParameters()
batchParameters
- Parameters used when the rule invokes Amazon AWS Batch Job/Queue.this
public RuleTargetConfig.Builder deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig)
RuleTargetConfig.getDeadLetterConfig()
deadLetterConfig
- Contains information about a dead-letter queue configuration.this
public RuleTargetConfig.Builder ecsParameters(CfnRule.EcsParametersProperty ecsParameters)
RuleTargetConfig.getEcsParameters()
ecsParameters
- The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.this
public RuleTargetConfig.Builder httpParameters(CfnRule.HttpParametersProperty httpParameters)
RuleTargetConfig.getHttpParameters()
httpParameters
- Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge API destination.this
@Deprecated public RuleTargetConfig.Builder id(java.lang.String id)
RuleTargetConfig.getId()
id
- A unique, user-defined identifier for the target.
Acceptable values
include alphanumeric characters, periods (.), hyphens (-), and
underscores (_).this
public RuleTargetConfig.Builder input(RuleTargetInput input)
RuleTargetConfig.getInput()
input
- What input to send to the event target.this
public RuleTargetConfig.Builder kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)
RuleTargetConfig.getKinesisParameters()
kinesisParameters
- Settings that control shard assignment, when the target is a Kinesis stream.
If you don't include this parameter, eventId is used as the
partition key.this
public RuleTargetConfig.Builder retryPolicy(CfnRule.RetryPolicyProperty retryPolicy)
RuleTargetConfig.getRetryPolicy()
retryPolicy
- A RetryPolicy object that includes information about the retry policy settings.this
public RuleTargetConfig.Builder role(IRole role)
RuleTargetConfig.getRole()
role
- Role to use to invoke this event target.this
public RuleTargetConfig.Builder runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)
RuleTargetConfig.getRunCommandParameters()
runCommandParameters
- Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.this
public RuleTargetConfig.Builder sqsParameters(CfnRule.SqsParametersProperty sqsParameters)
RuleTargetConfig.getSqsParameters()
sqsParameters
- Parameters used when the FIFO sqs queue is used an event target by the rule.this
public RuleTargetConfig.Builder targetResource(IConstruct targetResource)
RuleTargetConfig.getTargetResource()
targetResource
- The resource that is backing this target.
This is the resource that will actually have some action performed on it when used as a target
(for example, start a build for a CodeBuild project).
We need it to determine whether the rule belongs to a different account than the target -
if so, we generate a more complex setup,
including an additional stack containing the EventBusPolicy.this
public RuleTargetConfig build()
RuleTargetConfig
java.lang.NullPointerException
- if any required attribute was not provided