software.amazon.awscdk.services.events

Class CfnRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

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:

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

@Generated(value="jsii-pacmak/1.1.0 (build df55f5e)",
           date="2020-04-10T14:28:19.276Z")
 @Stability(value=External)
public class CfnRule
extends CfnResource
implements IInspectable

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.AwsVpcConfigurationProperty
static interface	CfnRule.BatchArrayPropertiesProperty
static interface	CfnRule.BatchParametersProperty
static interface	CfnRule.BatchRetryStrategyProperty
static class	CfnRule.Builder A fluent builder for CfnRule.
static interface	CfnRule.EcsParametersProperty
static interface	CfnRule.InputTransformerProperty
static interface	CfnRule.KinesisParametersProperty
static interface	CfnRule.NetworkConfigurationProperty
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

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

IInspectable.Jsii$Proxy

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(Construct scope, String id) Create a new `AWS::Events::Rule`.
	CfnRule(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.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

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

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, 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=External)
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=External)
public CfnRule(@NotNull
                                          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=External)
public CfnRule(@NotNull
                                          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=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

EXPERIMENTAL

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

@Stability(value=External)
 @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=External)
 @NotNull
public String getAttrArn()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getEventPattern

@Stability(value=External)
 @NotNull
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=External)
public void setEventPattern(@NotNull
                                                       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=External)
 @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=External)
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

getEventBusName

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

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

See Also:

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

setEventBusName

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

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

See Also:

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

getName

@Stability(value=External)
 @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=External)
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=External)
 @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=External)
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=External)
 @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=External)
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=External)
 @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=External)
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=External)
 @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=External)
public void setTargets(@Nullable
                                                  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=External)
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