software.amazon.awscdk.services.events

Class CfnRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.events.CfnRule

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:23.736Z")
 @Stability(value=Stable)
public class CfnRule
extends software.amazon.awscdk.core.CfnResource

A CloudFormation `AWS::Events::Rule`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnRule.EcsParametersProperty
static interface	CfnRule.InputTransformerProperty
static interface	CfnRule.KinesisParametersProperty
static interface	CfnRule.RunCommandParametersProperty
static interface	CfnRule.RunCommandTargetProperty
static interface	CfnRule.SqsParametersProperty
static interface	CfnRule.TargetProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

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.amazon.awscdk.core.Construct scope, String id) Create a new `AWS::Events::Rule`.
	CfnRule(software.amazon.awscdk.core.Construct scope, String id, CfnRuleProps props) Create a new `AWS::Events::Rule`.
protected	CfnRule(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Events::Rule.Description`.
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`.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::Events::Rule.Description`.
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(software.amazon.awscdk.core.IResolvable value) `AWS::Events::Rule.Targets`.
void	setTargets(List<Object> value) `AWS::Events::Rule.Targets`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, prepare

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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.JsiiObject.InitializationMode mode)

CfnRule

@Stability(value=Experimental)
public CfnRule(software.amazon.awscdk.core.Construct scope,
                                              String id,
                                              @Nullable
                                              CfnRuleProps props)

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

Parameters:

scope - - scope in which this resource is defined.

id - - scoped id of the resource.

props - - resource properties.

CfnRule

@Stability(value=Experimental)
public CfnRule(software.amazon.awscdk.core.Construct scope,
                                              String id)

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

Parameters:

scope - - scope in which this resource is defined.

id - - scoped id of the resource.

Method Detail

renderProperties

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

Overrides:

renderProperties in class software.amazon.awscdk.core.CfnResource

getAttrArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class software.amazon.awscdk.core.CfnResource

getEventPattern

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern

setEventPattern

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern

getDescription

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description

setDescription

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description

getName

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name

setName

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name

getRoleArn

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn

setRoleArn

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn

getScheduleExpression

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression

setScheduleExpression

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression

getState

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state

setState

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state

getTargets

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets

setTargets

@Stability(value=Stable)
public void setTargets(@Nullable
                                                software.amazon.awscdk.core.IResolvable value)

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets

setTargets

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

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

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets