Class: AWSCDK::SES::CfnConfigurationSet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSES::IConfigurationSetRef
Defined in:
ses/cfn_configuration_set.rb

Overview

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

Required permissions:

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

  • ses:GetConfigurationSet
  • (This permission is replacing the v1 ses:DescribeConfigurationSet permission which will not work with these v2 resource options.)
  • ses:PutConfigurationSetDeliveryOptions
  • ses:PutConfigurationSetReputationOptions
  • ses:PutConfigurationSetSendingOptions
  • ses:PutConfigurationSetSuppressionOptions
  • ses:PutConfigurationSetTrackingOptions

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnConfigurationSet

Create a new AWS::SES::ConfigurationSet.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::SES::CfnConfigurationSetProps, nil) (defaults to: nil) —

    Resource properties.



32
33
34
35
36
37
38
 
# File 'ses/cfn_configuration_set.rb', line 32

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkNmbkNvbmZpZ3VyYXRpb25TZXRQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_configuration_set(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'ses/cfn_configuration_set.rb', line 93

def self.arn_for_configuration_set(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zZXMuSUNvbmZpZ3VyYXRpb25TZXRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnConfigurationSet", "arnForConfigurationSet", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


213
214
215
 
# File 'ses/cfn_configuration_set.rb', line 213

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ses.CfnConfigurationSet", "CFN_RESOURCE_TYPE_NAME")
end

.from_configuration_set_name(scope, id, configuration_set_name) ⇒ AWSCDK::Interfaces::AWSSES::IConfigurationSetRef

Creates a new IConfigurationSetRef from a configurationSetName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • configuration_set_name (String)

Returns:



104
105
106
107
108
109
 
# File 'ses/cfn_configuration_set.rb', line 104

def self.from_configuration_set_name(scope, id, configuration_set_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(configuration_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationSetName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnConfigurationSet", "fromConfigurationSetName", [scope, id, configuration_set_name])
end

.is_cfn_configuration_set(x) ⇒ Boolean

Checks whether the given object is a CfnConfigurationSet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


115
116
117
118
 
# File 'ses/cfn_configuration_set.rb', line 115

def self.is_cfn_configuration_set(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnConfigurationSet", "isCfnConfigurationSet", [x])
end

.jsii_overridable_methods ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'ses/cfn_configuration_set.rb', line 40

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :configuration_set_ref => { kind: :property, name: "configurationSetRef", is_optional: false },
    :archiving_options => { kind: :property, name: "archivingOptions", is_optional: true },
    :delivery_options => { kind: :property, name: "deliveryOptions", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :reputation_options => { kind: :property, name: "reputationOptions", is_optional: true },
    :sending_options => { kind: :property, name: "sendingOptions", is_optional: true },
    :suppression_options => { kind: :property, name: "suppressionOptions", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :tracking_options => { kind: :property, name: "trackingOptions", is_optional: true },
    :vdm_options => { kind: :property, name: "vdmOptions", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



385
386
387
388
 
# File 'ses/cfn_configuration_set.rb', line 385

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



397
398
399
400
 
# File 'ses/cfn_configuration_set.rb', line 397

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



407
408
409
410
 
# File 'ses/cfn_configuration_set.rb', line 407

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



418
419
420
421
422
 
# File 'ses/cfn_configuration_set.rb', line 418

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


475
476
477
478
479
 
# File 'ses/cfn_configuration_set.rb', line 475

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



485
486
487
488
 
# File 'ses/cfn_configuration_set.rb', line 485

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



497
498
499
500
501
 
# File 'ses/cfn_configuration_set.rb', line 497

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



510
511
512
513
 
# File 'ses/cfn_configuration_set.rb', line 510

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



532
533
534
535
536
537
 
# File 'ses/cfn_configuration_set.rb', line 532

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#archiving_options ⇒ AWSCDK::IResolvable, ...

An object that defines a MailManager archive that is used to preserve emails that you send using the configuration set.

Returns:



234
235
236
 
# File 'ses/cfn_configuration_set.rb', line 234

def archiving_options()
  jsii_get_property("archivingOptions")
end

#archiving_options=(value) ⇒ Object 



238
239
240
241
242
 
# File 'ses/cfn_configuration_set.rb', line 238

def archiving_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::ArchivingOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5BcmNoaXZpbmdPcHRpb25zUHJvcGVydHkifV19fQ==")), "archivingOptions") unless value.nil?
  jsii_set_property("archivingOptions", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



220
221
222
 
# File 'ses/cfn_configuration_set.rb', line 220

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



166
167
168
 
# File 'ses/cfn_configuration_set.rb', line 166

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


171
172
173
 
# File 'ses/cfn_configuration_set.rb', line 171

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


541
542
543
544
 
# File 'ses/cfn_configuration_set.rb', line 541

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


176
177
178
 
# File 'ses/cfn_configuration_set.rb', line 176

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


183
184
185
 
# File 'ses/cfn_configuration_set.rb', line 183

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration_set_ref ⇒ AWSCDK::Interfaces::AWSSES::ConfigurationSetReference

A reference to a ConfigurationSet resource.

Returns:



227
228
229
 
# File 'ses/cfn_configuration_set.rb', line 227

def configuration_set_ref()
  jsii_get_property("configurationSetRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


128
129
130
 
# File 'ses/cfn_configuration_set.rb', line 128

def creation_stack()
  jsii_get_property("creationStack")
end

#delivery_options ⇒ AWSCDK::IResolvable, ...

Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Returns:



247
248
249
 
# File 'ses/cfn_configuration_set.rb', line 247

def delivery_options()
  jsii_get_property("deliveryOptions")
end

#delivery_options=(value) ⇒ Object 



251
252
253
254
255
 
# File 'ses/cfn_configuration_set.rb', line 251

def delivery_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::DeliveryOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5EZWxpdmVyeU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "deliveryOptions") unless value.nil?
  jsii_set_property("deliveryOptions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



188
189
190
 
# File 'ses/cfn_configuration_set.rb', line 188

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



554
555
556
557
558
 
# File 'ses/cfn_configuration_set.rb', line 554

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



565
566
567
568
 
# File 'ses/cfn_configuration_set.rb', line 565

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



635
636
637
638
 
# File 'ses/cfn_configuration_set.rb', line 635

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


140
141
142
 
# File 'ses/cfn_configuration_set.rb', line 140

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the configuration set.

The name must meet the following requirements:.

Returns:

  • (String, nil) 


262
263
264
 
# File 'ses/cfn_configuration_set.rb', line 262

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



266
267
268
269
 
# File 'ses/cfn_configuration_set.rb', line 266

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


123
124
125
 
# File 'ses/cfn_configuration_set.rb', line 123

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



576
577
578
 
# File 'ses/cfn_configuration_set.rb', line 576

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



583
584
585
 
# File 'ses/cfn_configuration_set.rb', line 583

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



376
377
378
379
 
# File 'ses/cfn_configuration_set.rb', line 376

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


159
160
161
 
# File 'ses/cfn_configuration_set.rb', line 159

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



594
595
596
597
 
# File 'ses/cfn_configuration_set.rb', line 594

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


601
602
603
604
 
# File 'ses/cfn_configuration_set.rb', line 601

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



611
612
613
614
615
 
# File 'ses/cfn_configuration_set.rb', line 611

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#reputation_options ⇒ AWSCDK::IResolvable, ...

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

Returns:



274
275
276
 
# File 'ses/cfn_configuration_set.rb', line 274

def reputation_options()
  jsii_get_property("reputationOptions")
end

#reputation_options=(value) ⇒ Object 



278
279
280
281
282
 
# File 'ses/cfn_configuration_set.rb', line 278

def reputation_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::ReputationOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5SZXB1dGF0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "reputationOptions") unless value.nil?
  jsii_set_property("reputationOptions", value)
end

#sending_options ⇒ AWSCDK::IResolvable, ...

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

Returns:



287
288
289
 
# File 'ses/cfn_configuration_set.rb', line 287

def sending_options()
  jsii_get_property("sendingOptions")
end

#sending_options=(value) ⇒ Object 



291
292
293
294
295
 
# File 'ses/cfn_configuration_set.rb', line 291

def sending_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::SendingOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5TZW5kaW5nT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "sendingOptions") unless value.nil?
  jsii_set_property("sendingOptions", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



620
621
622
 
# File 'ses/cfn_configuration_set.rb', line 620

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



149
150
151
 
# File 'ses/cfn_configuration_set.rb', line 149

def stack()
  jsii_get_property("stack")
end

#suppression_options ⇒ AWSCDK::IResolvable, ...

An object that contains information about the suppression list preferences for your account.

Returns:



300
301
302
 
# File 'ses/cfn_configuration_set.rb', line 300

def suppression_options()
  jsii_get_property("suppressionOptions")
end

#suppression_options=(value) ⇒ Object 



304
305
306
307
308
 
# File 'ses/cfn_configuration_set.rb', line 304

def suppression_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::SuppressionOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5TdXBwcmVzc2lvbk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "suppressionOptions") unless value.nil?
  jsii_set_property("suppressionOptions", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of objects that define the tags (keys and values) that are associated with the configuration set.

Returns:



313
314
315
 
# File 'ses/cfn_configuration_set.rb', line 313

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



317
318
319
320
321
 
# File 'ses/cfn_configuration_set.rb', line 317

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



352
353
354
 
# File 'ses/cfn_configuration_set.rb', line 352

def to_string()
  jsii_call_method("toString", [])
end

#tracking_options ⇒ AWSCDK::IResolvable, ...

An object that defines the open and click tracking options for emails that you send using the configuration set.

Returns:



326
327
328
 
# File 'ses/cfn_configuration_set.rb', line 326

def tracking_options()
  jsii_get_property("trackingOptions")
end

#tracking_options=(value) ⇒ Object 



330
331
332
333
334
 
# File 'ses/cfn_configuration_set.rb', line 330

def tracking_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::TrackingOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5UcmFja2luZ09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "trackingOptions") unless value.nil?
  jsii_set_property("trackingOptions", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


196
197
198
 
# File 'ses/cfn_configuration_set.rb', line 196

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


206
207
208
 
# File 'ses/cfn_configuration_set.rb', line 206

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


626
627
628
629
 
# File 'ses/cfn_configuration_set.rb', line 626

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vdm_options ⇒ AWSCDK::IResolvable, ...

The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

Returns:



339
340
341
 
# File 'ses/cfn_configuration_set.rb', line 339

def vdm_options()
  jsii_get_property("vdmOptions")
end

#vdm_options=(value) ⇒ Object 



343
344
345
346
347
 
# File 'ses/cfn_configuration_set.rb', line 343

def vdm_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnConfigurationSet::VdmOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuQ29uZmlndXJhdGlvblNldC5WZG1PcHRpb25zUHJvcGVydHkifV19fQ==")), "vdmOptions") unless value.nil?
  jsii_set_property("vdmOptions", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


365
366
367
368
369
370
 
# File 'ses/cfn_configuration_set.rb', line 365

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end