software.amazon.awscdk.services.events

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.553Z")
 @Stability(value=Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Events::Rule`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 Object eventPattern;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .description("description")
         .eventBusName("eventBusName")
         .eventPattern(eventPattern)
         .name("name")
         .roleArn("roleArn")
         .scheduleExpression("scheduleExpression")
         .state("state")
         .targets(List.of(TargetProperty.builder()
                 .arn("arn")
                 .id("id")
                 // the properties below are optional
                 .batchParameters(BatchParametersProperty.builder()
                         .jobDefinition("jobDefinition")
                         .jobName("jobName")
                         // the properties below are optional
                         .arrayProperties(BatchArrayPropertiesProperty.builder()
                                 .size(123)
                                 .build())
                         .retryStrategy(BatchRetryStrategyProperty.builder()
                                 .attempts(123)
                                 .build())
                         .build())
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .ecsParameters(EcsParametersProperty.builder()
                         .taskDefinitionArn("taskDefinitionArn")
                         // the properties below are optional
                         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                                 .capacityProvider("capacityProvider")
                                 // the properties below are optional
                                 .base(123)
                                 .weight(123)
                                 .build()))
                         .enableEcsManagedTags(false)
                         .enableExecuteCommand(false)
                         .group("group")
                         .launchType("launchType")
                         .networkConfiguration(NetworkConfigurationProperty.builder()
                                 .awsVpcConfiguration(AwsVpcConfigurationProperty.builder()
                                         .subnets(List.of("subnets"))
                                         // the properties below are optional
                                         .assignPublicIp("assignPublicIp")
                                         .securityGroups(List.of("securityGroups"))
                                         .build())
                                 .build())
                         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                                 .expression("expression")
                                 .type("type")
                                 .build()))
                         .placementStrategies(List.of(PlacementStrategyProperty.builder()
                                 .field("field")
                                 .type("type")
                                 .build()))
                         .platformVersion("platformVersion")
                         .propagateTags("propagateTags")
                         .referenceId("referenceId")
                         .tagList(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .taskCount(123)
                         .build())
                 .httpParameters(HttpParametersProperty.builder()
                         .headerParameters(Map.of(
                                 "headerParametersKey", "headerParameters"))
                         .pathParameterValues(List.of("pathParameterValues"))
                         .queryStringParameters(Map.of(
                                 "queryStringParametersKey", "queryStringParameters"))
                         .build())
                 .input("input")
                 .inputPath("inputPath")
                 .inputTransformer(InputTransformerProperty.builder()
                         .inputTemplate("inputTemplate")
                         // the properties below are optional
                         .inputPathsMap(Map.of(
                                 "inputPathsMapKey", "inputPathsMap"))
                         .build())
                 .kinesisParameters(KinesisParametersProperty.builder()
                         .partitionKeyPath("partitionKeyPath")
                         .build())
                 .redshiftDataParameters(RedshiftDataParametersProperty.builder()
                         .database("database")
                         .sql("sql")
                         // the properties below are optional
                         .dbUser("dbUser")
                         .secretManagerArn("secretManagerArn")
                         .statementName("statementName")
                         .withEvent(false)
                         .build())
                 .retryPolicy(RetryPolicyProperty.builder()
                         .maximumEventAgeInSeconds(123)
                         .maximumRetryAttempts(123)
                         .build())
                 .roleArn("roleArn")
                 .runCommandParameters(RunCommandParametersProperty.builder()
                         .runCommandTargets(List.of(RunCommandTargetProperty.builder()
                                 .key("key")
                                 .values(List.of("values"))
                                 .build()))
                         .build())
                 .sqsParameters(SqsParametersProperty.builder()
                         .messageGroupId("messageGroupId")
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRuleProps.Builder A builder for CfnRuleProps
static class	CfnRuleProps.Jsii$Proxy An implementation for CfnRuleProps

Method Summary

Modifier and Type	Method and Description
static CfnRuleProps.Builder	builder()
default String	getDescription() `AWS::Events::Rule.Description`.
default String	getEventBusName() `AWS::Events::Rule.EventBusName`.
default Object	getEventPattern() `AWS::Events::Rule.EventPattern`.
default String	getName() `AWS::Events::Rule.Name`.
default String	getRoleArn() `AWS::Events::Rule.RoleArn`.
default String	getScheduleExpression() `AWS::Events::Rule.ScheduleExpression`.
default String	getState() `AWS::Events::Rule.State`.
default Object	getTargets() `AWS::Events::Rule.Targets`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Events::Rule.Description`.

getEventBusName

@Stability(value=Stable)
 @Nullable
default String getEventBusName()

`AWS::Events::Rule.EventBusName`.

getEventPattern

@Stability(value=Stable)
 @Nullable
default Object getEventPattern()

`AWS::Events::Rule.EventPattern`.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`AWS::Events::Rule.Name`.

getRoleArn

@Stability(value=Stable)
 @Nullable
default String getRoleArn()

`AWS::Events::Rule.RoleArn`.

getScheduleExpression

@Stability(value=Stable)
 @Nullable
default String getScheduleExpression()

`AWS::Events::Rule.ScheduleExpression`.

getState

@Stability(value=Stable)
 @Nullable
default String getState()

`AWS::Events::Rule.State`.

getTargets

@Stability(value=Stable)
 @Nullable
default Object getTargets()

`AWS::Events::Rule.Targets`.

builder

@Stability(value=Stable)
static CfnRuleProps.Builder builder()

Returns:

a CfnRuleProps.Builder of CfnRuleProps