software.amazon.awscdk.services.events

Class RuleTargetConfig.Builder

java.lang.Object

software.amazon.awscdk.services.events.RuleTargetConfig.Builder

Enclosing interface:

RuleTargetConfig

public static final class RuleTargetConfig.Builder
extends java.lang.Object

A builder for RuleTargetConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig.Builder	arn(java.lang.String arn) Sets the value of RuleTargetConfig.getArn()
RuleTargetConfig.Builder	batchParameters(CfnRule.BatchParametersProperty batchParameters) Sets the value of RuleTargetConfig.getBatchParameters()
RuleTargetConfig	build() Builds the configured instance.
RuleTargetConfig.Builder	deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig) Sets the value of RuleTargetConfig.getDeadLetterConfig()
RuleTargetConfig.Builder	ecsParameters(CfnRule.EcsParametersProperty ecsParameters) Sets the value of RuleTargetConfig.getEcsParameters()
RuleTargetConfig.Builder	httpParameters(CfnRule.HttpParametersProperty httpParameters) Sets the value of RuleTargetConfig.getHttpParameters()
RuleTargetConfig.Builder	id(java.lang.String id) Deprecated. no replacement. we will always use an autogenerated id.
RuleTargetConfig.Builder	input(RuleTargetInput input) Sets the value of RuleTargetConfig.getInput()
RuleTargetConfig.Builder	kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters) Sets the value of RuleTargetConfig.getKinesisParameters()
RuleTargetConfig.Builder	retryPolicy(CfnRule.RetryPolicyProperty retryPolicy) Sets the value of RuleTargetConfig.getRetryPolicy()
RuleTargetConfig.Builder	role(IRole role) Sets the value of RuleTargetConfig.getRole()
RuleTargetConfig.Builder	runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters) Sets the value of RuleTargetConfig.getRunCommandParameters()
RuleTargetConfig.Builder	sqsParameters(CfnRule.SqsParametersProperty sqsParameters) Sets the value of RuleTargetConfig.getSqsParameters()
RuleTargetConfig.Builder	targetResource(IConstruct targetResource) Sets the value of RuleTargetConfig.getTargetResource()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

arn

public RuleTargetConfig.Builder arn(java.lang.String arn)

Sets the value of RuleTargetConfig.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target. This parameter is required.

Returns:

this

batchParameters

public RuleTargetConfig.Builder batchParameters(CfnRule.BatchParametersProperty batchParameters)

Sets the value of RuleTargetConfig.getBatchParameters()

Parameters:

batchParameters - Parameters used when the rule invokes Amazon AWS Batch Job/Queue.

Returns:

this

deadLetterConfig

public RuleTargetConfig.Builder deadLetterConfig(CfnRule.DeadLetterConfigProperty deadLetterConfig)

Sets the value of RuleTargetConfig.getDeadLetterConfig()

Parameters:

deadLetterConfig - Contains information about a dead-letter queue configuration.

Returns:

this

ecsParameters

public RuleTargetConfig.Builder ecsParameters(CfnRule.EcsParametersProperty ecsParameters)

Sets the value of RuleTargetConfig.getEcsParameters()

Parameters:

ecsParameters - The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.

Returns:

this

httpParameters

public RuleTargetConfig.Builder httpParameters(CfnRule.HttpParametersProperty httpParameters)

Sets the value of RuleTargetConfig.getHttpParameters()

Parameters:

httpParameters - Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge API destination.

Returns:

this

id

@Deprecated
public RuleTargetConfig.Builder id(java.lang.String id)

Deprecated. no replacement. we will always use an autogenerated id.

Sets the value of RuleTargetConfig.getId()

Parameters:

id - A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_).

Returns:

this

input

public RuleTargetConfig.Builder input(RuleTargetInput input)

Sets the value of RuleTargetConfig.getInput()

Parameters:

input - What input to send to the event target.

Returns:

this

kinesisParameters

public RuleTargetConfig.Builder kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)

Sets the value of RuleTargetConfig.getKinesisParameters()

Parameters:

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.

Returns:

this

retryPolicy

public RuleTargetConfig.Builder retryPolicy(CfnRule.RetryPolicyProperty retryPolicy)

Sets the value of RuleTargetConfig.getRetryPolicy()

Parameters:

retryPolicy - A RetryPolicy object that includes information about the retry policy settings.

Returns:

this

role

public RuleTargetConfig.Builder role(IRole role)

Sets the value of RuleTargetConfig.getRole()

Parameters:

role - Role to use to invoke this event target.

Returns:

this

runCommandParameters

public RuleTargetConfig.Builder runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)

Sets the value of RuleTargetConfig.getRunCommandParameters()

Parameters:

runCommandParameters - Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

Returns:

this

sqsParameters

public RuleTargetConfig.Builder sqsParameters(CfnRule.SqsParametersProperty sqsParameters)

Sets the value of RuleTargetConfig.getSqsParameters()

Parameters:

sqsParameters - Parameters used when the FIFO sqs queue is used an event target by the rule.

Returns:

this

targetResource

public RuleTargetConfig.Builder targetResource(IConstruct targetResource)

Sets the value of RuleTargetConfig.getTargetResource()

Parameters:

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.

Returns:

this

build

public RuleTargetConfig build()

Builds the configured instance.

Returns:

a new instance of RuleTargetConfig

Throws:

java.lang.NullPointerException - if any required attribute was not provided