awsevents

package
v2.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 22, 2021 License: Apache-2.0 Imports: 7 Imported by: 44

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Archive_IsConstruct 

func Archive_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Archive_IsResource 

func Archive_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func CfnApiDestination_CFN_RESOURCE_TYPE_NAME 

func CfnApiDestination_CFN_RESOURCE_TYPE_NAME() *string

func CfnApiDestination_IsCfnElement 

func CfnApiDestination_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApiDestination_IsCfnResource 

func CfnApiDestination_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApiDestination_IsConstruct 

func CfnApiDestination_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnArchive_CFN_RESOURCE_TYPE_NAME 

func CfnArchive_CFN_RESOURCE_TYPE_NAME() *string

func CfnArchive_IsCfnElement 

func CfnArchive_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnArchive_IsCfnResource 

func CfnArchive_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnArchive_IsConstruct 

func CfnArchive_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnConnection_CFN_RESOURCE_TYPE_NAME 

func CfnConnection_CFN_RESOURCE_TYPE_NAME() *string

func CfnConnection_IsCfnElement 

func CfnConnection_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnConnection_IsCfnResource 

func CfnConnection_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnConnection_IsConstruct 

func CfnConnection_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEventBusPolicy_CFN_RESOURCE_TYPE_NAME 

func CfnEventBusPolicy_CFN_RESOURCE_TYPE_NAME() *string

func CfnEventBusPolicy_IsCfnElement 

func CfnEventBusPolicy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEventBusPolicy_IsCfnResource 

func CfnEventBusPolicy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEventBusPolicy_IsConstruct 

func CfnEventBusPolicy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEventBus_CFN_RESOURCE_TYPE_NAME 

func CfnEventBus_CFN_RESOURCE_TYPE_NAME() *string

func CfnEventBus_IsCfnElement 

func CfnEventBus_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEventBus_IsCfnResource 

func CfnEventBus_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEventBus_IsConstruct 

func CfnEventBus_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnRule_CFN_RESOURCE_TYPE_NAME 

func CfnRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnRule_IsCfnElement 

func CfnRule_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnRule_IsCfnResource 

func CfnRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRule_IsConstruct 

func CfnRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EventBus_GrantAllPutEvents 

func EventBus_GrantAllPutEvents(grantee awsiam.IGrantable) awsiam.Grant

Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

func EventBus_IsConstruct 

func EventBus_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func EventBus_IsResource 

func EventBus_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func EventField_Account 

func EventField_Account() *string

func EventField_DetailType 

func EventField_DetailType() *string

func EventField_EventId 

func EventField_EventId() *string

func EventField_FromPath 

func EventField_FromPath(path *string) *string

Extract a custom JSON path from the event.

func EventField_Region 

func EventField_Region() *string

func EventField_Source 

func EventField_Source() *string

func EventField_Time 

func EventField_Time() *string

func NewArchive_Override 

func NewArchive_Override(a Archive, scope constructs.Construct, id *string, props *ArchiveProps)

func NewCfnApiDestination_Override 

func NewCfnApiDestination_Override(c CfnApiDestination, scope constructs.Construct, id *string, props *CfnApiDestinationProps)

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

func NewCfnArchive_Override 

func NewCfnArchive_Override(c CfnArchive, scope constructs.Construct, id *string, props *CfnArchiveProps)

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

func NewCfnConnection_Override 

func NewCfnConnection_Override(c CfnConnection, scope constructs.Construct, id *string, props *CfnConnectionProps)

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

func NewCfnEventBusPolicy_Override 

func NewCfnEventBusPolicy_Override(c CfnEventBusPolicy, scope constructs.Construct, id *string, props *CfnEventBusPolicyProps)

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

func NewCfnEventBus_Override 

func NewCfnEventBus_Override(c CfnEventBus, scope constructs.Construct, id *string, props *CfnEventBusProps)

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

func NewCfnRule_Override 

func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)

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

func NewEventBus_Override 

func NewEventBus_Override(e EventBus, scope constructs.Construct, id *string, props *EventBusProps)

func NewRuleTargetInput_Override 

func NewRuleTargetInput_Override(r RuleTargetInput)

func NewRule_Override 

func NewRule_Override(r Rule, scope constructs.Construct, id *string, props *RuleProps)

func NewSchedule_Override 

func NewSchedule_Override(s Schedule)

func Rule_IsConstruct 

func Rule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Rule_IsResource 

func Rule_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type Archive 

type Archive interface {
	awscdk.Resource
	ArchiveArn() *string
	ArchiveName() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

Define an EventBridge Archive.

TODO: EXAMPLE

func NewArchive 

func NewArchive(scope constructs.Construct, id *string, props *ArchiveProps) Archive

type ArchiveProps 

type ArchiveProps struct {
	// The name of the archive.
	ArchiveName *string `json:"archiveName"`
	// A description for the archive.
	Description *string `json:"description"`
	// An event pattern to use to filter events sent to the archive.
	EventPattern *EventPattern `json:"eventPattern"`
	// The number of days to retain events for.
	//
	// Default value is 0. If set to 0, events are retained indefinitely.
	Retention awscdk.Duration `json:"retention"`
	// The event source associated with the archive.
	SourceEventBus IEventBus `json:"sourceEventBus"`
}

The event archive properties.

TODO: EXAMPLE

type BaseArchiveProps 

type BaseArchiveProps struct {
	// The name of the archive.
	ArchiveName *string `json:"archiveName"`
	// A description for the archive.
	Description *string `json:"description"`
	// An event pattern to use to filter events sent to the archive.
	EventPattern *EventPattern `json:"eventPattern"`
	// The number of days to retain events for.
	//
	// Default value is 0. If set to 0, events are retained indefinitely.
	Retention awscdk.Duration `json:"retention"`
}

The event archive base properties.

TODO: EXAMPLE

type CfnApiDestination 

type CfnApiDestination interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionArn() *string
	SetConnectionArn(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	HttpMethod() *string
	SetHttpMethod(val *string)
	InvocationEndpoint() *string
	SetInvocationEndpoint(val *string)
	InvocationRateLimitPerSecond() *float64
	SetInvocationRateLimitPerSecond(val *float64)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Events::ApiDestination`.

TODO: EXAMPLE

func NewCfnApiDestination 

func NewCfnApiDestination(scope constructs.Construct, id *string, props *CfnApiDestinationProps) CfnApiDestination

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

type CfnApiDestinationProps 

type CfnApiDestinationProps struct {
	// `AWS::Events::ApiDestination.ConnectionArn`.
	ConnectionArn *string `json:"connectionArn"`
	// `AWS::Events::ApiDestination.Description`.
	Description *string `json:"description"`
	// `AWS::Events::ApiDestination.HttpMethod`.
	HttpMethod *string `json:"httpMethod"`
	// `AWS::Events::ApiDestination.InvocationEndpoint`.
	InvocationEndpoint *string `json:"invocationEndpoint"`
	// `AWS::Events::ApiDestination.InvocationRateLimitPerSecond`.
	InvocationRateLimitPerSecond *float64 `json:"invocationRateLimitPerSecond"`
	// `AWS::Events::ApiDestination.Name`.
	Name *string `json:"name"`
}

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

TODO: EXAMPLE

type CfnArchive 

type CfnArchive interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ArchiveName() *string
	SetArchiveName(val *string)
	AttrArchiveName() *string
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EventPattern() interface{}
	SetEventPattern(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RetentionDays() *float64
	SetRetentionDays(val *float64)
	SourceArn() *string
	SetSourceArn(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Events::Archive`.

TODO: EXAMPLE

func NewCfnArchive 

func NewCfnArchive(scope constructs.Construct, id *string, props *CfnArchiveProps) CfnArchive

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

type CfnArchiveProps 

type CfnArchiveProps struct {
	// `AWS::Events::Archive.ArchiveName`.
	ArchiveName *string `json:"archiveName"`
	// `AWS::Events::Archive.Description`.
	Description *string `json:"description"`
	// `AWS::Events::Archive.EventPattern`.
	EventPattern interface{} `json:"eventPattern"`
	// `AWS::Events::Archive.RetentionDays`.
	RetentionDays *float64 `json:"retentionDays"`
	// `AWS::Events::Archive.SourceArn`.
	SourceArn *string `json:"sourceArn"`
}

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

TODO: EXAMPLE

type CfnConnection 

type CfnConnection interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrSecretArn() *string
	AuthorizationType() *string
	SetAuthorizationType(val *string)
	AuthParameters() interface{}
	SetAuthParameters(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Events::Connection`.

TODO: EXAMPLE

func NewCfnConnection 

func NewCfnConnection(scope constructs.Construct, id *string, props *CfnConnectionProps) CfnConnection

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

type CfnConnectionProps 

type CfnConnectionProps struct {
	// `AWS::Events::Connection.AuthorizationType`.
	AuthorizationType *string `json:"authorizationType"`
	// `AWS::Events::Connection.AuthParameters`.
	AuthParameters interface{} `json:"authParameters"`
	// `AWS::Events::Connection.Description`.
	Description *string `json:"description"`
	// `AWS::Events::Connection.Name`.
	Name *string `json:"name"`
}

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

TODO: EXAMPLE

type CfnEventBus 

type CfnEventBus interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrName() *string
	AttrPolicy() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EventSourceName() *string
	SetEventSourceName(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Events::EventBus`.

TODO: EXAMPLE

func NewCfnEventBus 

func NewCfnEventBus(scope constructs.Construct, id *string, props *CfnEventBusProps) CfnEventBus

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

type CfnEventBusPolicy 

type CfnEventBusPolicy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Action() *string
	SetAction(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Condition() interface{}
	SetCondition(val interface{})
	CreationStack() *[]*string
	EventBusName() *string
	SetEventBusName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Principal() *string
	SetPrincipal(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Statement() interface{}
	SetStatement(val interface{})
	StatementId() *string
	SetStatementId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Events::EventBusPolicy`.

TODO: EXAMPLE

func NewCfnEventBusPolicy 

func NewCfnEventBusPolicy(scope constructs.Construct, id *string, props *CfnEventBusPolicyProps) CfnEventBusPolicy

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

type CfnEventBusPolicyProps 

type CfnEventBusPolicyProps struct {
	// `AWS::Events::EventBusPolicy.Action`.
	Action *string `json:"action"`
	// `AWS::Events::EventBusPolicy.Condition`.
	Condition interface{} `json:"condition"`
	// `AWS::Events::EventBusPolicy.EventBusName`.
	EventBusName *string `json:"eventBusName"`
	// `AWS::Events::EventBusPolicy.Principal`.
	Principal *string `json:"principal"`
	// `AWS::Events::EventBusPolicy.Statement`.
	Statement interface{} `json:"statement"`
	// `AWS::Events::EventBusPolicy.StatementId`.
	StatementId *string `json:"statementId"`
}

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

TODO: EXAMPLE

type CfnEventBusPolicy_ConditionProperty 

type CfnEventBusPolicy_ConditionProperty struct {
	// `CfnEventBusPolicy.ConditionProperty.Key`.
	Key *string `json:"key"`
	// `CfnEventBusPolicy.ConditionProperty.Type`.
	Type *string `json:"type"`
	// `CfnEventBusPolicy.ConditionProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type CfnEventBusProps 

type CfnEventBusProps struct {
	// `AWS::Events::EventBus.EventSourceName`.
	EventSourceName *string `json:"eventSourceName"`
	// `AWS::Events::EventBus.Name`.
	Name *string `json:"name"`
}

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

TODO: EXAMPLE

type CfnRule 

type CfnRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EventBusName() *string
	SetEventBusName(val *string)
	EventPattern() interface{}
	SetEventPattern(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	ScheduleExpression() *string
	SetScheduleExpression(val *string)
	Stack() awscdk.Stack
	State() *string
	SetState(val *string)
	Targets() interface{}
	SetTargets(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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

TODO: EXAMPLE

func NewCfnRule 

func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule

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

type CfnRuleProps 

type CfnRuleProps struct {
	// `AWS::Events::Rule.Description`.
	Description *string `json:"description"`
	// `AWS::Events::Rule.EventBusName`.
	EventBusName *string `json:"eventBusName"`
	// `AWS::Events::Rule.EventPattern`.
	EventPattern interface{} `json:"eventPattern"`
	// `AWS::Events::Rule.Name`.
	Name *string `json:"name"`
	// `AWS::Events::Rule.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `AWS::Events::Rule.ScheduleExpression`.
	ScheduleExpression *string `json:"scheduleExpression"`
	// `AWS::Events::Rule.State`.
	State *string `json:"state"`
	// `AWS::Events::Rule.Targets`.
	Targets interface{} `json:"targets"`
}

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

TODO: EXAMPLE

type CfnRule_AwsVpcConfigurationProperty 

type CfnRule_AwsVpcConfigurationProperty struct {
	// `CfnRule.AwsVpcConfigurationProperty.AssignPublicIp`.
	AssignPublicIp *string `json:"assignPublicIp"`
	// `CfnRule.AwsVpcConfigurationProperty.SecurityGroups`.
	SecurityGroups *[]*string `json:"securityGroups"`
	// `CfnRule.AwsVpcConfigurationProperty.Subnets`.
	Subnets *[]*string `json:"subnets"`
}

TODO: EXAMPLE

type CfnRule_BatchArrayPropertiesProperty 

type CfnRule_BatchArrayPropertiesProperty struct {
	// `CfnRule.BatchArrayPropertiesProperty.Size`.
	Size *float64 `json:"size"`
}

TODO: EXAMPLE

type CfnRule_BatchParametersProperty 

type CfnRule_BatchParametersProperty struct {
	// `CfnRule.BatchParametersProperty.ArrayProperties`.
	ArrayProperties interface{} `json:"arrayProperties"`
	// `CfnRule.BatchParametersProperty.JobDefinition`.
	JobDefinition *string `json:"jobDefinition"`
	// `CfnRule.BatchParametersProperty.JobName`.
	JobName *string `json:"jobName"`
	// `CfnRule.BatchParametersProperty.RetryStrategy`.
	RetryStrategy interface{} `json:"retryStrategy"`
}

TODO: EXAMPLE

type CfnRule_BatchRetryStrategyProperty 

type CfnRule_BatchRetryStrategyProperty struct {
	// `CfnRule.BatchRetryStrategyProperty.Attempts`.
	Attempts *float64 `json:"attempts"`
}

TODO: EXAMPLE

type CfnRule_CapacityProviderStrategyItemProperty 

type CfnRule_CapacityProviderStrategyItemProperty struct {
	// `CfnRule.CapacityProviderStrategyItemProperty.Base`.
	Base *float64 `json:"base"`
	// `CfnRule.CapacityProviderStrategyItemProperty.CapacityProvider`.
	CapacityProvider *string `json:"capacityProvider"`
	// `CfnRule.CapacityProviderStrategyItemProperty.Weight`.
	Weight *float64 `json:"weight"`
}

TODO: EXAMPLE

type CfnRule_DeadLetterConfigProperty 

type CfnRule_DeadLetterConfigProperty struct {
	// `CfnRule.DeadLetterConfigProperty.Arn`.
	Arn *string `json:"arn"`
}

TODO: EXAMPLE

type CfnRule_EcsParametersProperty 

type CfnRule_EcsParametersProperty struct {
	// `CfnRule.EcsParametersProperty.CapacityProviderStrategy`.
	CapacityProviderStrategy interface{} `json:"capacityProviderStrategy"`
	// `CfnRule.EcsParametersProperty.EnableECSManagedTags`.
	EnableEcsManagedTags interface{} `json:"enableEcsManagedTags"`
	// `CfnRule.EcsParametersProperty.EnableExecuteCommand`.
	EnableExecuteCommand interface{} `json:"enableExecuteCommand"`
	// `CfnRule.EcsParametersProperty.Group`.
	Group *string `json:"group"`
	// `CfnRule.EcsParametersProperty.LaunchType`.
	LaunchType *string `json:"launchType"`
	// `CfnRule.EcsParametersProperty.NetworkConfiguration`.
	NetworkConfiguration interface{} `json:"networkConfiguration"`
	// `CfnRule.EcsParametersProperty.PlacementConstraints`.
	PlacementConstraints interface{} `json:"placementConstraints"`
	// `CfnRule.EcsParametersProperty.PlacementStrategies`.
	PlacementStrategies interface{} `json:"placementStrategies"`
	// `CfnRule.EcsParametersProperty.PlatformVersion`.
	PlatformVersion *string `json:"platformVersion"`
	// `CfnRule.EcsParametersProperty.PropagateTags`.
	PropagateTags *string `json:"propagateTags"`
	// `CfnRule.EcsParametersProperty.ReferenceId`.
	ReferenceId *string `json:"referenceId"`
	// `CfnRule.EcsParametersProperty.TagList`.
	TagList interface{} `json:"tagList"`
	// `CfnRule.EcsParametersProperty.TaskCount`.
	TaskCount *float64 `json:"taskCount"`
	// `CfnRule.EcsParametersProperty.TaskDefinitionArn`.
	TaskDefinitionArn *string `json:"taskDefinitionArn"`
}

TODO: EXAMPLE

type CfnRule_HttpParametersProperty 

type CfnRule_HttpParametersProperty struct {
	// `CfnRule.HttpParametersProperty.HeaderParameters`.
	HeaderParameters interface{} `json:"headerParameters"`
	// `CfnRule.HttpParametersProperty.PathParameterValues`.
	PathParameterValues *[]*string `json:"pathParameterValues"`
	// `CfnRule.HttpParametersProperty.QueryStringParameters`.
	QueryStringParameters interface{} `json:"queryStringParameters"`
}

TODO: EXAMPLE

type CfnRule_InputTransformerProperty 

type CfnRule_InputTransformerProperty struct {
	// `CfnRule.InputTransformerProperty.InputPathsMap`.
	InputPathsMap interface{} `json:"inputPathsMap"`
	// `CfnRule.InputTransformerProperty.InputTemplate`.
	InputTemplate *string `json:"inputTemplate"`
}

TODO: EXAMPLE

type CfnRule_KinesisParametersProperty 

type CfnRule_KinesisParametersProperty struct {
	// `CfnRule.KinesisParametersProperty.PartitionKeyPath`.
	PartitionKeyPath *string `json:"partitionKeyPath"`
}

TODO: EXAMPLE

type CfnRule_NetworkConfigurationProperty 

type CfnRule_NetworkConfigurationProperty struct {
	// `CfnRule.NetworkConfigurationProperty.AwsVpcConfiguration`.
	AwsVpcConfiguration interface{} `json:"awsVpcConfiguration"`
}

TODO: EXAMPLE

type CfnRule_PlacementConstraintProperty 

type CfnRule_PlacementConstraintProperty struct {
	// `CfnRule.PlacementConstraintProperty.Expression`.
	Expression *string `json:"expression"`
	// `CfnRule.PlacementConstraintProperty.Type`.
	Type *string `json:"type"`
}

TODO: EXAMPLE

type CfnRule_PlacementStrategyProperty 

type CfnRule_PlacementStrategyProperty struct {
	// `CfnRule.PlacementStrategyProperty.Field`.
	Field *string `json:"field"`
	// `CfnRule.PlacementStrategyProperty.Type`.
	Type *string `json:"type"`
}

TODO: EXAMPLE

type CfnRule_RedshiftDataParametersProperty 

type CfnRule_RedshiftDataParametersProperty struct {
	// `CfnRule.RedshiftDataParametersProperty.Database`.
	Database *string `json:"database"`
	// `CfnRule.RedshiftDataParametersProperty.DbUser`.
	DbUser *string `json:"dbUser"`
	// `CfnRule.RedshiftDataParametersProperty.SecretManagerArn`.
	SecretManagerArn *string `json:"secretManagerArn"`
	// `CfnRule.RedshiftDataParametersProperty.Sql`.
	Sql *string `json:"sql"`
	// `CfnRule.RedshiftDataParametersProperty.StatementName`.
	StatementName *string `json:"statementName"`
	// `CfnRule.RedshiftDataParametersProperty.WithEvent`.
	WithEvent interface{} `json:"withEvent"`
}

TODO: EXAMPLE

type CfnRule_RetryPolicyProperty 

type CfnRule_RetryPolicyProperty struct {
	// `CfnRule.RetryPolicyProperty.MaximumEventAgeInSeconds`.
	MaximumEventAgeInSeconds *float64 `json:"maximumEventAgeInSeconds"`
	// `CfnRule.RetryPolicyProperty.MaximumRetryAttempts`.
	MaximumRetryAttempts *float64 `json:"maximumRetryAttempts"`
}

TODO: EXAMPLE

type CfnRule_RunCommandParametersProperty 

type CfnRule_RunCommandParametersProperty struct {
	// `CfnRule.RunCommandParametersProperty.RunCommandTargets`.
	RunCommandTargets interface{} `json:"runCommandTargets"`
}

TODO: EXAMPLE

type CfnRule_RunCommandTargetProperty 

type CfnRule_RunCommandTargetProperty struct {
	// `CfnRule.RunCommandTargetProperty.Key`.
	Key *string `json:"key"`
	// `CfnRule.RunCommandTargetProperty.Values`.
	Values *[]*string `json:"values"`
}

TODO: EXAMPLE

type CfnRule_SqsParametersProperty 

type CfnRule_SqsParametersProperty struct {
	// `CfnRule.SqsParametersProperty.MessageGroupId`.
	MessageGroupId *string `json:"messageGroupId"`
}

TODO: EXAMPLE

type CfnRule_TagProperty 

type CfnRule_TagProperty struct {
	// `CfnRule.TagProperty.Key`.
	Key *string `json:"key"`
	// `CfnRule.TagProperty.Value`.
	Value *string `json:"value"`
}

TODO: EXAMPLE

type CfnRule_TargetProperty 

type CfnRule_TargetProperty struct {
	// `CfnRule.TargetProperty.Arn`.
	Arn *string `json:"arn"`
	// `CfnRule.TargetProperty.BatchParameters`.
	BatchParameters interface{} `json:"batchParameters"`
	// `CfnRule.TargetProperty.DeadLetterConfig`.
	DeadLetterConfig interface{} `json:"deadLetterConfig"`
	// `CfnRule.TargetProperty.EcsParameters`.
	EcsParameters interface{} `json:"ecsParameters"`
	// `CfnRule.TargetProperty.HttpParameters`.
	HttpParameters interface{} `json:"httpParameters"`
	// `CfnRule.TargetProperty.Id`.
	Id *string `json:"id"`
	// `CfnRule.TargetProperty.Input`.
	Input *string `json:"input"`
	// `CfnRule.TargetProperty.InputPath`.
	InputPath *string `json:"inputPath"`
	// `CfnRule.TargetProperty.InputTransformer`.
	InputTransformer interface{} `json:"inputTransformer"`
	// `CfnRule.TargetProperty.KinesisParameters`.
	KinesisParameters interface{} `json:"kinesisParameters"`
	// `CfnRule.TargetProperty.RedshiftDataParameters`.
	RedshiftDataParameters interface{} `json:"redshiftDataParameters"`
	// `CfnRule.TargetProperty.RetryPolicy`.
	RetryPolicy interface{} `json:"retryPolicy"`
	// `CfnRule.TargetProperty.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `CfnRule.TargetProperty.RunCommandParameters`.
	RunCommandParameters interface{} `json:"runCommandParameters"`
	// `CfnRule.TargetProperty.SqsParameters`.
	SqsParameters interface{} `json:"sqsParameters"`
}

TODO: EXAMPLE

type CronOptions 

type CronOptions struct {
	// The day of the month to run this rule at.
	Day *string `json:"day"`
	// The hour to run this rule at.
	Hour *string `json:"hour"`
	// The minute to run this rule at.
	Minute *string `json:"minute"`
	// The month to run this rule at.
	Month *string `json:"month"`
	// The day of the week to run this rule at.
	WeekDay *string `json:"weekDay"`
	// The year to run this rule at.
	Year *string `json:"year"`
}

Options to configure a cron expression.

All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions

type EventBus 

type EventBus interface {
	awscdk.Resource
	IEventBus
	Env() *awscdk.ResourceEnvironment
	EventBusArn() *string
	EventBusName() *string
	EventBusPolicy() *string
	EventSourceName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Archive(id *string, props *BaseArchiveProps) Archive
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantPutEventsTo(grantee awsiam.IGrantable) awsiam.Grant
	ToString() *string
}

Define an EventBridge EventBus.

TODO: EXAMPLE

func NewEventBus 

func NewEventBus(scope constructs.Construct, id *string, props *EventBusProps) EventBus

type EventBusAttributes 

type EventBusAttributes struct {
	// The ARN of this event bus resource.
	EventBusArn *string `json:"eventBusArn"`
	// The physical ID of this event bus resource.
	EventBusName *string `json:"eventBusName"`
	// The JSON policy of this event bus resource.
	EventBusPolicy *string `json:"eventBusPolicy"`
	// The partner event source to associate with this event bus resource.
	EventSourceName *string `json:"eventSourceName"`
}

Interface with properties necessary to import a reusable EventBus.

TODO: EXAMPLE

type EventBusProps 

type EventBusProps struct {
	// The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
	EventBusName *string `json:"eventBusName"`
	// The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.
	EventSourceName *string `json:"eventSourceName"`
}

Properties to define an event bus.

TODO: EXAMPLE

type EventField 

type EventField interface {
	awscdk.IResolvable
	CreationStack() *[]*string
	DisplayHint() *string
	Path() *string
	Resolve(_ctx awscdk.IResolveContext) interface{}
	ToJSON() *string
	ToString() *string
}

Represents a field in the event pattern.

type EventPattern 

type EventPattern struct {
	// The 12-digit number identifying an AWS account.
	Account *[]*string `json:"account"`
	// A JSON object, whose content is at the discretion of the service originating the event.
	Detail *map[string]interface{} `json:"detail"`
	// Identifies, in combination with the source field, the fields and values that appear in the detail field.
	//
	// Represents the "detail-type" event field.
	DetailType *[]*string `json:"detailType"`
	// A unique value is generated for every event.
	//
	// This can be helpful in
	// tracing events as they move through rules to targets, and are processed.
	Id *[]*string `json:"id"`
	// Identifies the AWS region where the event originated.
	Region *[]*string `json:"region"`
	// This JSON array contains ARNs that identify resources that are involved in the event.
	//
	// Inclusion of these ARNs is at the discretion of the
	// service.
	//
	// For example, Amazon EC2 instance state-changes include Amazon EC2
	// instance ARNs, Auto Scaling events include ARNs for both instances and
	// Auto Scaling groups, but API calls with AWS CloudTrail do not include
	// resource ARNs.
	Resources *[]*string `json:"resources"`
	// Identifies the service that sourced the event.
	//
	// All events sourced from
	// within AWS begin with "aws." Customer-generated events can have any value
	// here, as long as it doesn't begin with "aws." We recommend the use of
	// Java package-name style reverse domain-name strings.
	//
	// To find the correct value for source for an AWS service, see the table in
	// AWS Service Namespaces. For example, the source value for Amazon
	// CloudFront is aws.cloudfront.
	// See: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces
	//
	Source *[]*string `json:"source"`
	// The event timestamp, which can be specified by the service originating the event.
	//
	// If the event spans a time interval, the service might choose
	// to report the start time, so this value can be noticeably before the time
	// the event is actually received.
	Time *[]*string `json:"time"`
	// By default, this is set to 0 (zero) in all events.
	Version *[]*string `json:"version"`
}

Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159.

**Important**: this class can only be used with a `Rule` class. In particular, do not use it with `CfnRule` class: your pattern will not be rendered correctly. In a `CfnRule` class, write the pattern as you normally would when directly writing CloudFormation.

Rules use event patterns to select events and route them to targets. A pattern either matches an event or it doesn't. Event patterns are represented as JSON objects with a structure that is similar to that of events.

It is important to remember the following about event pattern matching:

  • For a pattern to match an event, the event must contain all the field names listed in the pattern. The field names must appear in the event with the same nesting structure.
  • Other fields of the event not mentioned in the pattern are ignored; effectively, there is a “"*": "*"“ wildcard for fields not mentioned.
  • The matching is exact (character-by-character), without case-folding or any other string normalization.
  • The values being matched follow JSON rules: Strings enclosed in quotes, numbers, and the unquoted keywords true, false, and null.
  • Number matching is at the string representation level. For example, 300, 300.0, and 3.0e2 are not considered equal.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html

type IEventBus 

type IEventBus interface {
	awscdk.IResource
	// Create an EventBridge archive to send events to.
	//
	// When you create an archive, incoming events might not immediately start being sent to the archive.
	// Allow a short period of time for changes to take effect.
	Archive(id *string, props *BaseArchiveProps) Archive
	// Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.
	GrantPutEventsTo(grantee awsiam.IGrantable) awsiam.Grant
	// The ARN of this event bus resource.
	EventBusArn() *string
	// The physical ID of this event bus resource.
	EventBusName() *string
	// The JSON policy of this event bus resource.
	EventBusPolicy() *string
	// The partner event source to associate with this event bus resource.
	EventSourceName() *string
}

Interface which all EventBus based classes MUST implement.

func EventBus_FromEventBusArn 

func EventBus_FromEventBusArn(scope constructs.Construct, id *string, eventBusArn *string) IEventBus

Import an existing event bus resource.

func EventBus_FromEventBusAttributes 

func EventBus_FromEventBusAttributes(scope constructs.Construct, id *string, attrs *EventBusAttributes) IEventBus

Import an existing event bus resource.

func EventBus_FromEventBusName 

func EventBus_FromEventBusName(scope constructs.Construct, id *string, eventBusName *string) IEventBus

Import an existing event bus resource.

type IRule 

type IRule interface {
	awscdk.IResource
	// The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
	RuleArn() *string
	// The name event rule.
	RuleName() *string
}

Represents an EventBridge Rule.

func Rule_FromEventRuleArn 

func Rule_FromEventRuleArn(scope constructs.Construct, id *string, eventRuleArn *string) IRule

Import an existing EventBridge Rule provided an ARN.

type IRuleTarget 

type IRuleTarget interface {
	// Returns the rule target specification.
	//
	// NOTE: Do not use the various `inputXxx` options. They can be set in a call to `addTarget`.
	Bind(rule IRule, id *string) *RuleTargetConfig
}

An abstract target for EventRules.

type OnEventOptions 

type OnEventOptions struct {
	// A description of the rule's purpose.
	Description *string `json:"description"`
	// Additional restrictions for the event to route to the specified target.
	//
	// The method that generates the rule probably imposes some type of event
	// filtering. The filtering implied by what you pass here is added
	// on top of that filtering.
	// See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
	//
	EventPattern *EventPattern `json:"eventPattern"`
	// A name for the rule.
	RuleName *string `json:"ruleName"`
	// The target to register for the event.
	Target IRuleTarget `json:"target"`
}

Standard set of options for `onXxx` event handlers on construct.

TODO: EXAMPLE

type Rule 

type Rule interface {
	awscdk.Resource
	IRule
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	RuleArn() *string
	RuleName() *string
	Stack() awscdk.Stack
	AddEventPattern(eventPattern *EventPattern)
	AddTarget(target IRuleTarget)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
	ValidateRule() *[]*string
}

Defines an EventBridge Rule in this stack.

TODO: EXAMPLE

func NewRule 

func NewRule(scope constructs.Construct, id *string, props *RuleProps) Rule

type RuleProps 

type RuleProps struct {
	// A description of the rule's purpose.
	Description *string `json:"description"`
	// Indicates whether the rule is enabled.
	Enabled *bool `json:"enabled"`
	// The event bus to associate with this rule.
	EventBus IEventBus `json:"eventBus"`
	// Describes which events EventBridge routes to the specified target.
	//
	// These routed events are matched events. For more information, see Events
	// and Event Patterns in the Amazon EventBridge User Guide.
	// See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
	//
	// You must specify this property (either via props or via
	// `addEventPattern`), the `scheduleExpression` property, or both. The
	// method `addEventPattern` can be used to add filter values to the event
	// pattern.
	//
	EventPattern *EventPattern `json:"eventPattern"`
	// A name for the rule.
	RuleName *string `json:"ruleName"`
	// The schedule or rate (frequency) that determines when EventBridge runs the rule.
	//
	// For more information, see Schedule Expression Syntax for
	// Rules in the Amazon EventBridge User Guide.
	// See: https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html
	//
	// You must specify this property, the `eventPattern` property, or both.
	//
	Schedule Schedule `json:"schedule"`
	// Targets to invoke when this rule matches an event.
	//
	// Input will be the full matched event. If you wish to specify custom
	// target input, use `addTarget(target[, inputOptions])`.
	Targets *[]IRuleTarget `json:"targets"`
}

Properties for defining an EventBridge Rule.

TODO: EXAMPLE

type RuleTargetConfig 

type RuleTargetConfig struct {
	// The Amazon Resource Name (ARN) of the target.
	Arn *string `json:"arn"`
	// Parameters used when the rule invokes Amazon AWS Batch Job/Queue.
	BatchParameters *CfnRule_BatchParametersProperty `json:"batchParameters"`
	// Contains information about a dead-letter queue configuration.
	DeadLetterConfig *CfnRule_DeadLetterConfigProperty `json:"deadLetterConfig"`
	// The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.
	EcsParameters *CfnRule_EcsParametersProperty `json:"ecsParameters"`
	// Parameters used when the rule invoke api gateway.
	HttpParameters *CfnRule_HttpParametersProperty `json:"httpParameters"`
	// What input to send to the event target.
	Input RuleTargetInput `json:"input"`
	// 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.
	KinesisParameters *CfnRule_KinesisParametersProperty `json:"kinesisParameters"`
	// A RetryPolicy object that includes information about the retry policy settings.
	RetryPolicy *CfnRule_RetryPolicyProperty `json:"retryPolicy"`
	// Role to use to invoke this event target.
	Role awsiam.IRole `json:"role"`
	// Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.
	RunCommandParameters *CfnRule_RunCommandParametersProperty `json:"runCommandParameters"`
	// Parameters used when the FIFO sqs queue is used an event target by the rule.
	SqsParameters *CfnRule_SqsParametersProperty `json:"sqsParameters"`
	// The resource that is backing this target.
	//
	// This is the resource that will actually have some action performed on it when used as a target
	// (for example, start a build for a CodeBuild project).
	// We need it to determine whether the rule belongs to a different account than the target -
	// if so, we generate a more complex setup,
	// including an additional stack containing the EventBusPolicy.
	// See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
	//
	TargetResource constructs.IConstruct `json:"targetResource"`
}

Properties for an event rule target.

TODO: EXAMPLE

type RuleTargetInput 

type RuleTargetInput interface {
	Bind(rule IRule) *RuleTargetInputProperties
}

The input to send to the event target.

TODO: EXAMPLE

func RuleTargetInput_FromEventPath 

func RuleTargetInput_FromEventPath(path *string) RuleTargetInput

Take the event target input from a path in the event JSON.

func RuleTargetInput_FromMultilineText 

func RuleTargetInput_FromMultilineText(text *string) RuleTargetInput

Pass text to the event target, splitting on newlines.

This is only useful when passing to a target that does not take a single argument.

May contain strings returned by EventField.from() to substitute in parts of the matched event.

func RuleTargetInput_FromObject 

func RuleTargetInput_FromObject(obj interface{}) RuleTargetInput

Pass a JSON object to the event target.

May contain strings returned by EventField.from() to substitute in parts of the matched event.

func RuleTargetInput_FromText 

func RuleTargetInput_FromText(text *string) RuleTargetInput

Pass text to the event target.

May contain strings returned by EventField.from() to substitute in parts of the matched event.

type RuleTargetInputProperties 

type RuleTargetInputProperties struct {
	// Literal input to the target service (must be valid JSON).
	Input *string `json:"input"`
	// JsonPath to take input from the input event.
	InputPath *string `json:"inputPath"`
	// Paths map to extract values from event and insert into `inputTemplate`.
	InputPathsMap *map[string]*string `json:"inputPathsMap"`
	// Input template to insert paths map into.
	InputTemplate *string `json:"inputTemplate"`
}

The input properties for an event target.

TODO: EXAMPLE

type Schedule 

type Schedule interface {
	ExpressionString() *string
}

Schedule for scheduled event rules.

TODO: EXAMPLE

func Schedule_Cron 

func Schedule_Cron(options *CronOptions) Schedule

Create a schedule from a set of cron fields.

func Schedule_Expression 

func Schedule_Expression(expression *string) Schedule

Construct a schedule from a literal schedule expression.

func Schedule_Rate 

func Schedule_Rate(duration awscdk.Duration) Schedule

Construct a schedule from an interval and a time unit.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.