software.amazon.awscdk.services.events

Class CfnRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.events.CfnRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.654Z")
 @Stability(value=Stable)
public class CfnRule
extends CfnResource
implements IInspectable

A CloudFormation `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;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .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	Class and Description
static interface	CfnRule.AwsVpcConfigurationProperty Example:
static interface	CfnRule.BatchArrayPropertiesProperty Example:
static interface	CfnRule.BatchParametersProperty Example:
static interface	CfnRule.BatchRetryStrategyProperty Example:
static class	CfnRule.Builder A fluent builder for CfnRule.
static interface	CfnRule.CapacityProviderStrategyItemProperty Example:
static interface	CfnRule.DeadLetterConfigProperty Example:
static interface	CfnRule.EcsParametersProperty Example:
static interface	CfnRule.HttpParametersProperty Example:
static interface	CfnRule.InputTransformerProperty Example:
static interface	CfnRule.KinesisParametersProperty Example:
static interface	CfnRule.NetworkConfigurationProperty Example:
static interface	CfnRule.PlacementConstraintProperty Example:
static interface	CfnRule.PlacementStrategyProperty Example:
static interface	CfnRule.RedshiftDataParametersProperty Example:
static interface	CfnRule.RetryPolicyProperty Example:
static interface	CfnRule.RunCommandParametersProperty Example:
static interface	CfnRule.RunCommandTargetProperty Example:
static interface	CfnRule.SqsParametersProperty Example:
static interface	CfnRule.TagProperty Example:
static interface	CfnRule.TargetProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRule(software.constructs.Construct scope, String id) Create a new `AWS::Events::Rule`.
	CfnRule(software.constructs.Construct scope, String id, CfnRuleProps props) Create a new `AWS::Events::Rule`.
protected	CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Events::Rule.Description`.
String	getEventBusName() `AWS::Events::Rule.EventBusName`.
Object	getEventPattern() `AWS::Events::Rule.EventPattern`.
String	getName() `AWS::Events::Rule.Name`.
String	getRoleArn() `AWS::Events::Rule.RoleArn`.
String	getScheduleExpression() `AWS::Events::Rule.ScheduleExpression`.
String	getState() `AWS::Events::Rule.State`.
Object	getTargets() `AWS::Events::Rule.Targets`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::Events::Rule.Description`.
void	setEventBusName(String value) `AWS::Events::Rule.EventBusName`.
void	setEventPattern(Object value) `AWS::Events::Rule.EventPattern`.
void	setName(String value) `AWS::Events::Rule.Name`.
void	setRoleArn(String value) `AWS::Events::Rule.RoleArn`.
void	setScheduleExpression(String value) `AWS::Events::Rule.ScheduleExpression`.
void	setState(String value) `AWS::Events::Rule.State`.
void	setTargets(IResolvable value) `AWS::Events::Rule.Targets`.
void	setTargets(List<Object> value) `AWS::Events::Rule.Targets`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRule

protected CfnRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnRule

protected CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRule

@Stability(value=Stable)
public CfnRule(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @Nullable
                                        CfnRuleProps props)

Create a new `AWS::Events::Rule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnRule

@Stability(value=Stable)
public CfnRule(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id)

Create a new `AWS::Events::Rule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

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

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getEventBusName

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

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

setEventBusName

@Stability(value=Stable)
public void setEventBusName(@Nullable
                                                     String value)

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

getEventPattern

@Stability(value=Stable)
 @NotNull
public Object getEventPattern()

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

setEventPattern

@Stability(value=Stable)
public void setEventPattern(@NotNull
                                                     Object value)

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

getName

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

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

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

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

getRoleArn

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

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

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

getScheduleExpression

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

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

setScheduleExpression

@Stability(value=Stable)
public void setScheduleExpression(@Nullable
                                                           String value)

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

getState

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

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

setState

@Stability(value=Stable)
public void setState(@Nullable
                                              String value)

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

getTargets

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

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

setTargets

@Stability(value=Stable)
public void setTargets(@Nullable
                                                IResolvable value)

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

setTargets

@Stability(value=Stable)
public void setTargets(@Nullable
                                                List<Object> value)

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