software.amazon.awscdk.services.events

Interface EventRuleTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EventRuleTargetProps.Jsii$Pojo, EventRuleTargetProps.Jsii$Proxy

public interface EventRuleTargetProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventRuleTargetProps.Builder A fluent step builder class for EventRuleTargetProps.
static class	EventRuleTargetProps.Jsii$Pojo A PoJo (plain-old-java-object) class that implements EventRuleTargetProps.
static class	EventRuleTargetProps.Jsii$Proxy A proxy class which for javascript object literal which adhere to this interface.

Method Summary

Modifier and Type	Method and Description
static EventRuleTargetProps.Builder	builder()
software.amazon.awscdk.Arn	getArn() The Amazon Resource Name (ARN) of the target.
RuleResource.EcsParametersProperty	getEcsParameters() The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.
String	getId() A unique, user-defined identifier for the target.
RuleResource.KinesisParametersProperty	getKinesisParameters() Settings that control shard assignment, when the target is a Kinesis stream.
software.amazon.awscdk.services.iam.RoleArn	getRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered.
RuleResource.RunCommandParametersProperty	getRunCommandParameters() Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.
void	setArn(software.amazon.awscdk.Arn value) The Amazon Resource Name (ARN) of the target.
void	setEcsParameters(RuleResource.EcsParametersProperty value) The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.
void	setId(String value) A unique, user-defined identifier for the target.
void	setKinesisParameters(RuleResource.KinesisParametersProperty value) Settings that control shard assignment, when the target is a Kinesis stream.
void	setRoleArn(software.amazon.awscdk.services.iam.RoleArn value) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered.
void	setRunCommandParameters(RuleResource.RunCommandParametersProperty value) Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

Method Detail

getId

String getId()

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

setId

void setId(String value)

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

getArn

software.amazon.awscdk.Arn getArn()

The Amazon Resource Name (ARN) of the target.

setArn

void setArn(software.amazon.awscdk.Arn value)

The Amazon Resource Name (ARN) of the target.

getRoleArn

software.amazon.awscdk.services.iam.RoleArn getRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

setRoleArn

void setRoleArn(software.amazon.awscdk.services.iam.RoleArn value)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to use for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

getEcsParameters

RuleResource.EcsParametersProperty getEcsParameters()

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

setEcsParameters

void setEcsParameters(RuleResource.EcsParametersProperty value)

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

getKinesisParameters

RuleResource.KinesisParametersProperty getKinesisParameters()

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.

setKinesisParameters

void setKinesisParameters(RuleResource.KinesisParametersProperty value)

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.

getRunCommandParameters

RuleResource.RunCommandParametersProperty getRunCommandParameters()

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

setRunCommandParameters

void setRunCommandParameters(RuleResource.RunCommandParametersProperty value)

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

builder

static EventRuleTargetProps.Builder builder()