software.amazon.awscdk.services.events

Class RuleTargetConfig.Builder

java.lang.Object

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

Enclosing interface:

RuleTargetConfig

@Stability(value=Stable)
public static final class RuleTargetConfig.Builder
extends Object

A builder for RuleTargetConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig.Builder	arn(String arn) Sets the value of Arn
RuleTargetConfig	build() Builds the configured instance.
RuleTargetConfig.Builder	ecsParameters(CfnRule.EcsParametersProperty ecsParameters) Sets the value of EcsParameters
RuleTargetConfig.Builder	id(String id) Deprecated. prefer auto-generated id by specifying an empty string
RuleTargetConfig.Builder	input(RuleTargetInput input) Sets the value of Input
RuleTargetConfig.Builder	kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters) Sets the value of KinesisParameters
RuleTargetConfig.Builder	role(software.amazon.awscdk.services.iam.IRole role) Sets the value of Role
RuleTargetConfig.Builder	runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters) Sets the value of RunCommandParameters
RuleTargetConfig.Builder	sqsParameters(CfnRule.SqsParametersProperty sqsParameters) Sets the value of SqsParameters
RuleTargetConfig.Builder	targetResource(software.amazon.awscdk.core.IConstruct targetResource) Sets the value of TargetResource

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

@Stability(value=Stable)
public RuleTargetConfig.Builder arn(String arn)

Sets the value of Arn

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

this

id

@Deprecated
 @Stability(value=Deprecated)
public RuleTargetConfig.Builder id(String id)

Deprecated. prefer auto-generated id by specifying an empty string

Sets the value of Id

Parameters:

id - A unique, user-defined identifier for the target.

Returns:

this

ecsParameters

@Stability(value=Stable)
public RuleTargetConfig.Builder ecsParameters(CfnRule.EcsParametersProperty ecsParameters)

Sets the value of EcsParameters

Parameters:

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

Returns:

this

input

@Stability(value=Stable)
public RuleTargetConfig.Builder input(RuleTargetInput input)

Sets the value of Input

Parameters:

input - What input to send to the event target.

Returns:

this

kinesisParameters

@Stability(value=Stable)
public RuleTargetConfig.Builder kinesisParameters(CfnRule.KinesisParametersProperty kinesisParameters)

Sets the value of KinesisParameters

Parameters:

kinesisParameters - Settings that control shard assignment, when the target is a Kinesis stream.

Returns:

this

role

@Stability(value=Stable)
public RuleTargetConfig.Builder role(software.amazon.awscdk.services.iam.IRole role)

Sets the value of Role

Parameters:

role - Role to use to invoke this event target.

Returns:

this

runCommandParameters

@Stability(value=Stable)
public RuleTargetConfig.Builder runCommandParameters(CfnRule.RunCommandParametersProperty runCommandParameters)

Sets the value of RunCommandParameters

Parameters:

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

Returns:

this

sqsParameters

@Stability(value=Stable)
public RuleTargetConfig.Builder sqsParameters(CfnRule.SqsParametersProperty sqsParameters)

Sets the value of SqsParameters

Parameters:

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

Returns:

this

targetResource

@Stability(value=Stable)
public RuleTargetConfig.Builder targetResource(software.amazon.awscdk.core.IConstruct targetResource)

Sets the value of TargetResource

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

@Stability(value=Stable)
public RuleTargetConfig build()

Builds the configured instance.

Returns:

a new instance of RuleTargetConfig

Throws:

NullPointerException - if any required attribute was not provided