awsses

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: 6 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AllowListReceiptFilter_IsConstruct 

func AllowListReceiptFilter_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 CfnConfigurationSetEventDestination_CFN_RESOURCE_TYPE_NAME 

func CfnConfigurationSetEventDestination_CFN_RESOURCE_TYPE_NAME() *string

func CfnConfigurationSetEventDestination_IsCfnElement 

func CfnConfigurationSetEventDestination_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 CfnConfigurationSetEventDestination_IsCfnResource 

func CfnConfigurationSetEventDestination_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnConfigurationSetEventDestination_IsConstruct 

func CfnConfigurationSetEventDestination_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 CfnConfigurationSet_CFN_RESOURCE_TYPE_NAME 

func CfnConfigurationSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnConfigurationSet_IsCfnElement 

func CfnConfigurationSet_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 CfnConfigurationSet_IsCfnResource 

func CfnConfigurationSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnConfigurationSet_IsConstruct 

func CfnConfigurationSet_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 CfnContactList_CFN_RESOURCE_TYPE_NAME 

func CfnContactList_CFN_RESOURCE_TYPE_NAME() *string

func CfnContactList_IsCfnElement 

func CfnContactList_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 CfnContactList_IsCfnResource 

func CfnContactList_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContactList_IsConstruct 

func CfnContactList_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 CfnReceiptFilter_CFN_RESOURCE_TYPE_NAME 

func CfnReceiptFilter_CFN_RESOURCE_TYPE_NAME() *string

func CfnReceiptFilter_IsCfnElement 

func CfnReceiptFilter_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 CfnReceiptFilter_IsCfnResource 

func CfnReceiptFilter_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReceiptFilter_IsConstruct 

func CfnReceiptFilter_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 CfnReceiptRuleSet_CFN_RESOURCE_TYPE_NAME 

func CfnReceiptRuleSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnReceiptRuleSet_IsCfnElement 

func CfnReceiptRuleSet_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 CfnReceiptRuleSet_IsCfnResource 

func CfnReceiptRuleSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReceiptRuleSet_IsConstruct 

func CfnReceiptRuleSet_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 CfnReceiptRule_CFN_RESOURCE_TYPE_NAME 

func CfnReceiptRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnReceiptRule_IsCfnElement 

func CfnReceiptRule_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 CfnReceiptRule_IsCfnResource 

func CfnReceiptRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReceiptRule_IsConstruct 

func CfnReceiptRule_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 CfnTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnTemplate_IsCfnElement 

func CfnTemplate_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 CfnTemplate_IsCfnResource 

func CfnTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTemplate_IsConstruct 

func CfnTemplate_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 DropSpamReceiptRule_IsConstruct 

func DropSpamReceiptRule_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 NewAllowListReceiptFilter_Override 

func NewAllowListReceiptFilter_Override(a AllowListReceiptFilter, scope constructs.Construct, id *string, props *AllowListReceiptFilterProps)

func NewCfnConfigurationSetEventDestination_Override 

func NewCfnConfigurationSetEventDestination_Override(c CfnConfigurationSetEventDestination, scope constructs.Construct, id *string, props *CfnConfigurationSetEventDestinationProps)

Create a new `AWS::SES::ConfigurationSetEventDestination`.

func NewCfnConfigurationSet_Override 

func NewCfnConfigurationSet_Override(c CfnConfigurationSet, scope constructs.Construct, id *string, props *CfnConfigurationSetProps)

Create a new `AWS::SES::ConfigurationSet`.

func NewCfnContactList_Override 

func NewCfnContactList_Override(c CfnContactList, scope constructs.Construct, id *string, props *CfnContactListProps)

Create a new `AWS::SES::ContactList`.

func NewCfnReceiptFilter_Override 

func NewCfnReceiptFilter_Override(c CfnReceiptFilter, scope constructs.Construct, id *string, props *CfnReceiptFilterProps)

Create a new `AWS::SES::ReceiptFilter`.

func NewCfnReceiptRuleSet_Override 

func NewCfnReceiptRuleSet_Override(c CfnReceiptRuleSet, scope constructs.Construct, id *string, props *CfnReceiptRuleSetProps)

Create a new `AWS::SES::ReceiptRuleSet`.

func NewCfnReceiptRule_Override 

func NewCfnReceiptRule_Override(c CfnReceiptRule, scope constructs.Construct, id *string, props *CfnReceiptRuleProps)

Create a new `AWS::SES::ReceiptRule`.

func NewCfnTemplate_Override 

func NewCfnTemplate_Override(c CfnTemplate, scope constructs.Construct, id *string, props *CfnTemplateProps)

Create a new `AWS::SES::Template`.

func NewDropSpamReceiptRule_Override 

func NewDropSpamReceiptRule_Override(d DropSpamReceiptRule, scope constructs.Construct, id *string, props *DropSpamReceiptRuleProps)

func NewReceiptFilter_Override 

func NewReceiptFilter_Override(r ReceiptFilter, scope constructs.Construct, id *string, props *ReceiptFilterProps)

func NewReceiptRuleSet_Override 

func NewReceiptRuleSet_Override(r ReceiptRuleSet, scope constructs.Construct, id *string, props *ReceiptRuleSetProps)

func NewReceiptRule_Override 

func NewReceiptRule_Override(r ReceiptRule, scope constructs.Construct, id *string, props *ReceiptRuleProps)

func ReceiptFilter_IsConstruct 

func ReceiptFilter_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 ReceiptFilter_IsResource 

func ReceiptFilter_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func ReceiptRuleSet_IsConstruct 

func ReceiptRuleSet_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 ReceiptRuleSet_IsResource 

func ReceiptRuleSet_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func ReceiptRule_IsConstruct 

func ReceiptRule_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 ReceiptRule_IsResource 

func ReceiptRule_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type AddHeaderActionConfig 

type AddHeaderActionConfig struct {
	// The name of the header that you want to add to the incoming message.
	HeaderName *string `json:"headerName"`
	// The content that you want to include in the header.
	HeaderValue *string `json:"headerValue"`
}

AddHeaderAction configuration.

TODO: EXAMPLE

type AllowListReceiptFilter 

type AllowListReceiptFilter interface {
	constructs.Construct
	Node() constructs.Node
	ToString() *string
}

An allow list receipt filter.

TODO: EXAMPLE

func NewAllowListReceiptFilter 

func NewAllowListReceiptFilter(scope constructs.Construct, id *string, props *AllowListReceiptFilterProps) AllowListReceiptFilter

type AllowListReceiptFilterProps 

type AllowListReceiptFilterProps struct {
	// A list of ip addresses or ranges to allow list.
	Ips *[]*string `json:"ips"`
}

Construction properties for am AllowListReceiptFilter.

TODO: EXAMPLE

type BounceActionConfig 

type BounceActionConfig struct {
	// Human-readable text to include in the bounce message.
	Message *string `json:"message"`
	// The email address of the sender of the bounced email.
	//
	// This is the address that the bounce message is sent from.
	Sender *string `json:"sender"`
	// The SMTP reply code, as defined by RFC 5321.
	SmtpReplyCode *string `json:"smtpReplyCode"`
	// The SMTP enhanced status code, as defined by RFC 3463.
	StatusCode *string `json:"statusCode"`
	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.
	TopicArn *string `json:"topicArn"`
}

BoundAction configuration.

TODO: EXAMPLE

type CfnConfigurationSet 

type CfnConfigurationSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*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::SES::ConfigurationSet`.

TODO: EXAMPLE

func NewCfnConfigurationSet 

func NewCfnConfigurationSet(scope constructs.Construct, id *string, props *CfnConfigurationSetProps) CfnConfigurationSet

Create a new `AWS::SES::ConfigurationSet`.

type CfnConfigurationSetEventDestination 

type CfnConfigurationSetEventDestination interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationSetName() *string
	SetConfigurationSetName(val *string)
	CreationStack() *[]*string
	EventDestination() interface{}
	SetEventDestination(val interface{})
	LogicalId() *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::SES::ConfigurationSetEventDestination`.

TODO: EXAMPLE

func NewCfnConfigurationSetEventDestination 

func NewCfnConfigurationSetEventDestination(scope constructs.Construct, id *string, props *CfnConfigurationSetEventDestinationProps) CfnConfigurationSetEventDestination

Create a new `AWS::SES::ConfigurationSetEventDestination`.

type CfnConfigurationSetEventDestinationProps 

type CfnConfigurationSetEventDestinationProps struct {
	// `AWS::SES::ConfigurationSetEventDestination.ConfigurationSetName`.
	ConfigurationSetName *string `json:"configurationSetName"`
	// `AWS::SES::ConfigurationSetEventDestination.EventDestination`.
	EventDestination interface{} `json:"eventDestination"`
}

Properties for defining a `AWS::SES::ConfigurationSetEventDestination`.

TODO: EXAMPLE

type CfnConfigurationSetEventDestination_CloudWatchDestinationProperty 

type CfnConfigurationSetEventDestination_CloudWatchDestinationProperty struct {
	// `CfnConfigurationSetEventDestination.CloudWatchDestinationProperty.DimensionConfigurations`.
	DimensionConfigurations interface{} `json:"dimensionConfigurations"`
}

TODO: EXAMPLE

type CfnConfigurationSetEventDestination_DimensionConfigurationProperty 

type CfnConfigurationSetEventDestination_DimensionConfigurationProperty struct {
	// `CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DefaultDimensionValue`.
	DefaultDimensionValue *string `json:"defaultDimensionValue"`
	// `CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DimensionName`.
	DimensionName *string `json:"dimensionName"`
	// `CfnConfigurationSetEventDestination.DimensionConfigurationProperty.DimensionValueSource`.
	DimensionValueSource *string `json:"dimensionValueSource"`
}

TODO: EXAMPLE

type CfnConfigurationSetEventDestination_EventDestinationProperty 

type CfnConfigurationSetEventDestination_EventDestinationProperty struct {
	// `CfnConfigurationSetEventDestination.EventDestinationProperty.CloudWatchDestination`.
	CloudWatchDestination interface{} `json:"cloudWatchDestination"`
	// `CfnConfigurationSetEventDestination.EventDestinationProperty.Enabled`.
	Enabled interface{} `json:"enabled"`
	// `CfnConfigurationSetEventDestination.EventDestinationProperty.KinesisFirehoseDestination`.
	KinesisFirehoseDestination interface{} `json:"kinesisFirehoseDestination"`
	// `CfnConfigurationSetEventDestination.EventDestinationProperty.MatchingEventTypes`.
	MatchingEventTypes *[]*string `json:"matchingEventTypes"`
	// `CfnConfigurationSetEventDestination.EventDestinationProperty.Name`.
	Name *string `json:"name"`
}

TODO: EXAMPLE

type CfnConfigurationSetEventDestination_KinesisFirehoseDestinationProperty 

type CfnConfigurationSetEventDestination_KinesisFirehoseDestinationProperty struct {
	// `CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty.DeliveryStreamARN`.
	DeliveryStreamArn *string `json:"deliveryStreamArn"`
	// `CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty.IAMRoleARN`.
	IamRoleArn *string `json:"iamRoleArn"`
}

TODO: EXAMPLE

type CfnConfigurationSetProps 

type CfnConfigurationSetProps struct {
	// `AWS::SES::ConfigurationSet.Name`.
	Name *string `json:"name"`
}

Properties for defining a `AWS::SES::ConfigurationSet`.

TODO: EXAMPLE

type CfnContactList 

type CfnContactList interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ContactListName() *string
	SetContactListName(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Topics() interface{}
	SetTopics(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::SES::ContactList`.

TODO: EXAMPLE

func NewCfnContactList 

func NewCfnContactList(scope constructs.Construct, id *string, props *CfnContactListProps) CfnContactList

Create a new `AWS::SES::ContactList`.

type CfnContactListProps 

type CfnContactListProps struct {
	// `AWS::SES::ContactList.ContactListName`.
	ContactListName *string `json:"contactListName"`
	// `AWS::SES::ContactList.Description`.
	Description *string `json:"description"`
	// `AWS::SES::ContactList.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::SES::ContactList.Topics`.
	Topics interface{} `json:"topics"`
}

Properties for defining a `AWS::SES::ContactList`.

TODO: EXAMPLE

type CfnContactList_TopicProperty 

type CfnContactList_TopicProperty struct {
	// `CfnContactList.TopicProperty.DefaultSubscriptionStatus`.
	DefaultSubscriptionStatus *string `json:"defaultSubscriptionStatus"`
	// `CfnContactList.TopicProperty.Description`.
	Description *string `json:"description"`
	// `CfnContactList.TopicProperty.DisplayName`.
	DisplayName *string `json:"displayName"`
	// `CfnContactList.TopicProperty.TopicName`.
	TopicName *string `json:"topicName"`
}

TODO: EXAMPLE

type CfnReceiptFilter 

type CfnReceiptFilter interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Filter() interface{}
	SetFilter(val interface{})
	LogicalId() *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::SES::ReceiptFilter`.

TODO: EXAMPLE

func NewCfnReceiptFilter 

func NewCfnReceiptFilter(scope constructs.Construct, id *string, props *CfnReceiptFilterProps) CfnReceiptFilter

Create a new `AWS::SES::ReceiptFilter`.

type CfnReceiptFilterProps 

type CfnReceiptFilterProps struct {
	// `AWS::SES::ReceiptFilter.Filter`.
	Filter interface{} `json:"filter"`
}

Properties for defining a `AWS::SES::ReceiptFilter`.

TODO: EXAMPLE

type CfnReceiptFilter_FilterProperty 

type CfnReceiptFilter_FilterProperty struct {
	// `CfnReceiptFilter.FilterProperty.IpFilter`.
	IpFilter interface{} `json:"ipFilter"`
	// `CfnReceiptFilter.FilterProperty.Name`.
	Name *string `json:"name"`
}

TODO: EXAMPLE

type CfnReceiptFilter_IpFilterProperty 

type CfnReceiptFilter_IpFilterProperty struct {
	// `CfnReceiptFilter.IpFilterProperty.Cidr`.
	Cidr *string `json:"cidr"`
	// `CfnReceiptFilter.IpFilterProperty.Policy`.
	Policy *string `json:"policy"`
}

TODO: EXAMPLE

type CfnReceiptRule 

type CfnReceiptRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	After() *string
	SetAfter(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Rule() interface{}
	SetRule(val interface{})
	RuleSetName() *string
	SetRuleSetName(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::SES::ReceiptRule`.

TODO: EXAMPLE

func NewCfnReceiptRule 

func NewCfnReceiptRule(scope constructs.Construct, id *string, props *CfnReceiptRuleProps) CfnReceiptRule

Create a new `AWS::SES::ReceiptRule`.

type CfnReceiptRuleProps 

type CfnReceiptRuleProps struct {
	// `AWS::SES::ReceiptRule.After`.
	After *string `json:"after"`
	// `AWS::SES::ReceiptRule.Rule`.
	Rule interface{} `json:"rule"`
	// `AWS::SES::ReceiptRule.RuleSetName`.
	RuleSetName *string `json:"ruleSetName"`
}

Properties for defining a `AWS::SES::ReceiptRule`.

TODO: EXAMPLE

type CfnReceiptRuleSet 

type CfnReceiptRuleSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RuleSetName() *string
	SetRuleSetName(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::SES::ReceiptRuleSet`.

TODO: EXAMPLE

func NewCfnReceiptRuleSet 

func NewCfnReceiptRuleSet(scope constructs.Construct, id *string, props *CfnReceiptRuleSetProps) CfnReceiptRuleSet

Create a new `AWS::SES::ReceiptRuleSet`.

type CfnReceiptRuleSetProps 

type CfnReceiptRuleSetProps struct {
	// `AWS::SES::ReceiptRuleSet.RuleSetName`.
	RuleSetName *string `json:"ruleSetName"`
}

Properties for defining a `AWS::SES::ReceiptRuleSet`.

TODO: EXAMPLE

type CfnReceiptRule_ActionProperty 

type CfnReceiptRule_ActionProperty struct {
	// `CfnReceiptRule.ActionProperty.AddHeaderAction`.
	AddHeaderAction interface{} `json:"addHeaderAction"`
	// `CfnReceiptRule.ActionProperty.BounceAction`.
	BounceAction interface{} `json:"bounceAction"`
	// `CfnReceiptRule.ActionProperty.LambdaAction`.
	LambdaAction interface{} `json:"lambdaAction"`
	// `CfnReceiptRule.ActionProperty.S3Action`.
	S3Action interface{} `json:"s3Action"`
	// `CfnReceiptRule.ActionProperty.SNSAction`.
	SnsAction interface{} `json:"snsAction"`
	// `CfnReceiptRule.ActionProperty.StopAction`.
	StopAction interface{} `json:"stopAction"`
	// `CfnReceiptRule.ActionProperty.WorkmailAction`.
	WorkmailAction interface{} `json:"workmailAction"`
}

TODO: EXAMPLE

type CfnReceiptRule_AddHeaderActionProperty 

type CfnReceiptRule_AddHeaderActionProperty struct {
	// `CfnReceiptRule.AddHeaderActionProperty.HeaderName`.
	HeaderName *string `json:"headerName"`
	// `CfnReceiptRule.AddHeaderActionProperty.HeaderValue`.
	HeaderValue *string `json:"headerValue"`
}

TODO: EXAMPLE

type CfnReceiptRule_BounceActionProperty 

type CfnReceiptRule_BounceActionProperty struct {
	// `CfnReceiptRule.BounceActionProperty.Message`.
	Message *string `json:"message"`
	// `CfnReceiptRule.BounceActionProperty.Sender`.
	Sender *string `json:"sender"`
	// `CfnReceiptRule.BounceActionProperty.SmtpReplyCode`.
	SmtpReplyCode *string `json:"smtpReplyCode"`
	// `CfnReceiptRule.BounceActionProperty.StatusCode`.
	StatusCode *string `json:"statusCode"`
	// `CfnReceiptRule.BounceActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnReceiptRule_LambdaActionProperty 

type CfnReceiptRule_LambdaActionProperty struct {
	// `CfnReceiptRule.LambdaActionProperty.FunctionArn`.
	FunctionArn *string `json:"functionArn"`
	// `CfnReceiptRule.LambdaActionProperty.InvocationType`.
	InvocationType *string `json:"invocationType"`
	// `CfnReceiptRule.LambdaActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnReceiptRule_RuleProperty 

type CfnReceiptRule_RuleProperty struct {
	// `CfnReceiptRule.RuleProperty.Actions`.
	Actions interface{} `json:"actions"`
	// `CfnReceiptRule.RuleProperty.Enabled`.
	Enabled interface{} `json:"enabled"`
	// `CfnReceiptRule.RuleProperty.Name`.
	Name *string `json:"name"`
	// `CfnReceiptRule.RuleProperty.Recipients`.
	Recipients *[]*string `json:"recipients"`
	// `CfnReceiptRule.RuleProperty.ScanEnabled`.
	ScanEnabled interface{} `json:"scanEnabled"`
	// `CfnReceiptRule.RuleProperty.TlsPolicy`.
	TlsPolicy *string `json:"tlsPolicy"`
}

TODO: EXAMPLE

type CfnReceiptRule_S3ActionProperty 

type CfnReceiptRule_S3ActionProperty struct {
	// `CfnReceiptRule.S3ActionProperty.BucketName`.
	BucketName *string `json:"bucketName"`
	// `CfnReceiptRule.S3ActionProperty.KmsKeyArn`.
	KmsKeyArn *string `json:"kmsKeyArn"`
	// `CfnReceiptRule.S3ActionProperty.ObjectKeyPrefix`.
	ObjectKeyPrefix *string `json:"objectKeyPrefix"`
	// `CfnReceiptRule.S3ActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnReceiptRule_SNSActionProperty 

type CfnReceiptRule_SNSActionProperty struct {
	// `CfnReceiptRule.SNSActionProperty.Encoding`.
	Encoding *string `json:"encoding"`
	// `CfnReceiptRule.SNSActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnReceiptRule_StopActionProperty 

type CfnReceiptRule_StopActionProperty struct {
	// `CfnReceiptRule.StopActionProperty.Scope`.
	Scope *string `json:"scope"`
	// `CfnReceiptRule.StopActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnReceiptRule_WorkmailActionProperty 

type CfnReceiptRule_WorkmailActionProperty struct {
	// `CfnReceiptRule.WorkmailActionProperty.OrganizationArn`.
	OrganizationArn *string `json:"organizationArn"`
	// `CfnReceiptRule.WorkmailActionProperty.TopicArn`.
	TopicArn *string `json:"topicArn"`
}

TODO: EXAMPLE

type CfnTemplate 

type CfnTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Template() interface{}
	SetTemplate(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::SES::Template`.

TODO: EXAMPLE

func NewCfnTemplate 

func NewCfnTemplate(scope constructs.Construct, id *string, props *CfnTemplateProps) CfnTemplate

Create a new `AWS::SES::Template`.

type CfnTemplateProps 

type CfnTemplateProps struct {
	// `AWS::SES::Template.Template`.
	Template interface{} `json:"template"`
}

Properties for defining a `AWS::SES::Template`.

TODO: EXAMPLE

type CfnTemplate_TemplateProperty 

type CfnTemplate_TemplateProperty struct {
	// `CfnTemplate.TemplateProperty.HtmlPart`.
	HtmlPart *string `json:"htmlPart"`
	// `CfnTemplate.TemplateProperty.SubjectPart`.
	SubjectPart *string `json:"subjectPart"`
	// `CfnTemplate.TemplateProperty.TemplateName`.
	TemplateName *string `json:"templateName"`
	// `CfnTemplate.TemplateProperty.TextPart`.
	TextPart *string `json:"textPart"`
}

TODO: EXAMPLE

type DropSpamReceiptRule 

type DropSpamReceiptRule interface {
	constructs.Construct
	Node() constructs.Node
	Rule() ReceiptRule
	ToString() *string
}

A rule added at the top of the rule set to drop spam/virus.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda-example-functions.html

func NewDropSpamReceiptRule 

func NewDropSpamReceiptRule(scope constructs.Construct, id *string, props *DropSpamReceiptRuleProps) DropSpamReceiptRule

type DropSpamReceiptRuleProps 

type DropSpamReceiptRuleProps struct {
	// An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
	Actions *[]IReceiptRuleAction `json:"actions"`
	// An existing rule after which the new rule will be placed.
	After IReceiptRule `json:"after"`
	// Whether the rule is active.
	Enabled *bool `json:"enabled"`
	// The name for the rule.
	ReceiptRuleName *string `json:"receiptRuleName"`
	// The recipient domains and email addresses that the receipt rule applies to.
	Recipients *[]*string `json:"recipients"`
	// Whether to scan for spam and viruses.
	ScanEnabled *bool `json:"scanEnabled"`
	// Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
	TlsPolicy TlsPolicy `json:"tlsPolicy"`
	// The name of the rule set that the receipt rule will be added to.
	RuleSet IReceiptRuleSet `json:"ruleSet"`
}

TODO: EXAMPLE

type IReceiptRule 

type IReceiptRule interface {
	awscdk.IResource
	// The name of the receipt rule.
	ReceiptRuleName() *string
}

A receipt rule.

func ReceiptRule_FromReceiptRuleName 

func ReceiptRule_FromReceiptRuleName(scope constructs.Construct, id *string, receiptRuleName *string) IReceiptRule

type IReceiptRuleAction 

type IReceiptRuleAction interface {
	// Returns the receipt rule action specification.
	Bind(receiptRule IReceiptRule) *ReceiptRuleActionConfig
}

An abstract action for a receipt rule.

type IReceiptRuleSet 

type IReceiptRuleSet interface {
	awscdk.IResource
	// Adds a new receipt rule in this rule set.
	//
	// The new rule is added after
	// the last added rule unless `after` is specified.
	AddRule(id *string, options *ReceiptRuleOptions) ReceiptRule
	// The receipt rule set name.
	ReceiptRuleSetName() *string
}

A receipt rule set.

func ReceiptRuleSet_FromReceiptRuleSetName 

func ReceiptRuleSet_FromReceiptRuleSetName(scope constructs.Construct, id *string, receiptRuleSetName *string) IReceiptRuleSet

Import an exported receipt rule set.

type LambdaActionConfig 

type LambdaActionConfig struct {
	// The Amazon Resource Name (ARN) of the AWS Lambda function.
	FunctionArn *string `json:"functionArn"`
	// The invocation type of the AWS Lambda function.
	InvocationType *string `json:"invocationType"`
	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed.
	TopicArn *string `json:"topicArn"`
}

LambdaAction configuration.

TODO: EXAMPLE

type ReceiptFilter 

type ReceiptFilter interface {
	awscdk.Resource
	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
}

A receipt filter.

When instantiated without props, it creates a block all receipt filter.

TODO: EXAMPLE

func NewReceiptFilter 

func NewReceiptFilter(scope constructs.Construct, id *string, props *ReceiptFilterProps) ReceiptFilter

type ReceiptFilterPolicy 

type ReceiptFilterPolicy string

The policy for the receipt filter. 

const (
	ReceiptFilterPolicy_ALLOW ReceiptFilterPolicy = "ALLOW"
	ReceiptFilterPolicy_BLOCK ReceiptFilterPolicy = "BLOCK"
)

type ReceiptFilterProps 

type ReceiptFilterProps struct {
	// The ip address or range to filter.
	Ip *string `json:"ip"`
	// The policy for the filter.
	Policy ReceiptFilterPolicy `json:"policy"`
	// The name for the receipt filter.
	ReceiptFilterName *string `json:"receiptFilterName"`
}

Construction properties for a ReceiptFilter.

TODO: EXAMPLE

type ReceiptRule 

type ReceiptRule interface {
	awscdk.Resource
	IReceiptRule
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	ReceiptRuleName() *string
	Stack() awscdk.Stack
	AddAction(action IReceiptRuleAction)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A new receipt rule.

TODO: EXAMPLE

func NewReceiptRule 

func NewReceiptRule(scope constructs.Construct, id *string, props *ReceiptRuleProps) ReceiptRule

type ReceiptRuleActionConfig 

type ReceiptRuleActionConfig struct {
	// Adds a header to the received email.
	AddHeaderAction *AddHeaderActionConfig `json:"addHeaderAction"`
	// Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.
	BounceAction *BounceActionConfig `json:"bounceAction"`
	// Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
	LambdaAction *LambdaActionConfig `json:"lambdaAction"`
	// Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.
	S3Action *S3ActionConfig `json:"s3Action"`
	// Publishes the email content within a notification to Amazon SNS.
	SnsAction *SNSActionConfig `json:"snsAction"`
	// Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
	StopAction *StopActionConfig `json:"stopAction"`
	// Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
	WorkmailAction *WorkmailActionConfig `json:"workmailAction"`
}

Properties for a receipt rule action.

TODO: EXAMPLE

type ReceiptRuleOptions 

type ReceiptRuleOptions struct {
	// An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
	Actions *[]IReceiptRuleAction `json:"actions"`
	// An existing rule after which the new rule will be placed.
	After IReceiptRule `json:"after"`
	// Whether the rule is active.
	Enabled *bool `json:"enabled"`
	// The name for the rule.
	ReceiptRuleName *string `json:"receiptRuleName"`
	// The recipient domains and email addresses that the receipt rule applies to.
	Recipients *[]*string `json:"recipients"`
	// Whether to scan for spam and viruses.
	ScanEnabled *bool `json:"scanEnabled"`
	// Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
	TlsPolicy TlsPolicy `json:"tlsPolicy"`
}

Options to add a receipt rule to a receipt rule set.

TODO: EXAMPLE

type ReceiptRuleProps 

type ReceiptRuleProps struct {
	// An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
	Actions *[]IReceiptRuleAction `json:"actions"`
	// An existing rule after which the new rule will be placed.
	After IReceiptRule `json:"after"`
	// Whether the rule is active.
	Enabled *bool `json:"enabled"`
	// The name for the rule.
	ReceiptRuleName *string `json:"receiptRuleName"`
	// The recipient domains and email addresses that the receipt rule applies to.
	Recipients *[]*string `json:"recipients"`
	// Whether to scan for spam and viruses.
	ScanEnabled *bool `json:"scanEnabled"`
	// Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
	TlsPolicy TlsPolicy `json:"tlsPolicy"`
	// The name of the rule set that the receipt rule will be added to.
	RuleSet IReceiptRuleSet `json:"ruleSet"`
}

Construction properties for a ReceiptRule.

TODO: EXAMPLE

type ReceiptRuleSet 

type ReceiptRuleSet interface {
	awscdk.Resource
	IReceiptRuleSet
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	ReceiptRuleSetName() *string
	Stack() awscdk.Stack
	AddDropSpamRule()
	AddRule(id *string, options *ReceiptRuleOptions) ReceiptRule
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A new receipt rule set.

TODO: EXAMPLE

func NewReceiptRuleSet 

func NewReceiptRuleSet(scope constructs.Construct, id *string, props *ReceiptRuleSetProps) ReceiptRuleSet

type ReceiptRuleSetProps 

type ReceiptRuleSetProps struct {
	// Whether to add a first rule to stop processing messages that have at least one spam indicator.
	DropSpam *bool `json:"dropSpam"`
	// The name for the receipt rule set.
	ReceiptRuleSetName *string `json:"receiptRuleSetName"`
	// The list of rules to add to this rule set.
	//
	// Rules are added in the same
	// order as they appear in the list.
	Rules *[]*ReceiptRuleOptions `json:"rules"`
}

Construction properties for a ReceiptRuleSet.

TODO: EXAMPLE

type S3ActionConfig 

type S3ActionConfig struct {
	// The name of the Amazon S3 bucket that you want to send incoming mail to.
	BucketName *string `json:"bucketName"`
	// The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket.
	KmsKeyArn *string `json:"kmsKeyArn"`
	// The key prefix of the Amazon S3 bucket.
	ObjectKeyPrefix *string `json:"objectKeyPrefix"`
	// The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket.
	TopicArn *string `json:"topicArn"`
}

S3Action configuration.

TODO: EXAMPLE

type SNSActionConfig 

type SNSActionConfig struct {
	// The encoding to use for the email within the Amazon SNS notification.
	Encoding *string `json:"encoding"`
	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
	TopicArn *string `json:"topicArn"`
}

SNSAction configuration.

TODO: EXAMPLE

type StopActionConfig 

type StopActionConfig struct {
	// The scope of the StopAction.
	//
	// The only acceptable value is RuleSet.
	Scope *string `json:"scope"`
	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
	TopicArn *string `json:"topicArn"`
}

StopAction configuration.

TODO: EXAMPLE

type TlsPolicy 

type TlsPolicy string

The type of TLS policy for a receipt rule. 

const (
	TlsPolicy_OPTIONAL TlsPolicy = "OPTIONAL"
	TlsPolicy_REQUIRE  TlsPolicy = "REQUIRE"
)

type WorkmailActionConfig 

type WorkmailActionConfig struct {
	// The Amazon Resource Name (ARN) of the Amazon WorkMail organization.
	OrganizationArn *string `json:"organizationArn"`
	// The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called.
	TopicArn *string `json:"topicArn"`
}

WorkmailAction configuration.

TODO: EXAMPLE

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.