Class: AWSCDK::SES::CfnMailManagerIngressPoint

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

Overview

Resource to provision an ingress endpoint for receiving email.

An ingress endpoint serves as the entry point for incoming emails, allowing you to define how emails are received and processed within your AWS environment.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMailManagerIngressPoint

Create a new AWS::SES::MailManagerIngressPoint.

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::CfnMailManagerIngressPointProps)

    Resource properties.



20
21
22
23
24
25
26
# File 'ses/cfn_mail_manager_ingress_point.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SES::CfnMailManagerIngressPointProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkNmbk1haWxNYW5hZ2VySW5ncmVzc1BvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_mail_manager_ingress_point(resource) ⇒ String

Parameters:

Returns:

  • (String)


85
86
87
88
# File 'ses/cfn_mail_manager_ingress_point.rb', line 85

def self.arn_for_mail_manager_ingress_point(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zZXMuSU1haWxNYW5hZ2VySW5ncmVzc1BvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnMailManagerIngressPoint", "arnForMailManagerIngressPoint", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


218
219
220
# File 'ses/cfn_mail_manager_ingress_point.rb', line 218

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

.from_ingress_point_id(scope, id, ingress_point_id) ⇒ AWSCDK::Interfaces::AWSSES::IMailManagerIngressPointRef

Creates a new IMailManagerIngressPointRef from a ingressPointId.

Parameters:

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

Returns:



96
97
98
99
100
101
# File 'ses/cfn_mail_manager_ingress_point.rb', line 96

def self.from_ingress_point_id(scope, id, ingress_point_id)
  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(ingress_point_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ingressPointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnMailManagerIngressPoint", "fromIngressPointId", [scope, id, ingress_point_id])
end

.from_mail_manager_ingress_point_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSSES::IMailManagerIngressPointRef

Creates a new IMailManagerIngressPointRef from an ARN.

Parameters:

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

Returns:



109
110
111
112
113
114
# File 'ses/cfn_mail_manager_ingress_point.rb', line 109

def self.from_mail_manager_ingress_point_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.CfnMailManagerIngressPoint", "fromMailManagerIngressPointArn", [scope, id, arn])
end

.is_cfn_mail_manager_ingress_point(x) ⇒ Boolean

Checks whether the given object is a CfnMailManagerIngressPoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


120
121
122
123
# File 'ses/cfn_mail_manager_ingress_point.rb', line 120

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

.jsii_overridable_methodsObject



28
29
30
31
32
33
34
35
36
37
38
39
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
# File 'ses/cfn_mail_manager_ingress_point.rb', line 28

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 },
    :attr_a_record => { kind: :property, name: "attrARecord", is_optional: false },
    :attr_ingress_point_arn => { kind: :property, name: "attrIngressPointArn", is_optional: false },
    :attr_ingress_point_id => { kind: :property, name: "attrIngressPointId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :mail_manager_ingress_point_ref => { kind: :property, name: "mailManagerIngressPointRef", is_optional: false },
    :rule_set_id => { kind: :property, name: "ruleSetId", is_optional: false },
    :traffic_policy_id => { kind: :property, name: "trafficPolicyId", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :ingress_point_configuration => { kind: :property, name: "ingressPointConfiguration", is_optional: true },
    :ingress_point_name => { kind: :property, name: "ingressPointName", is_optional: true },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: true },
    :status_to_update => { kind: :property, name: "statusToUpdate", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :tls_policy => { kind: :property, name: "tlsPolicy", 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.



411
412
413
414
# File 'ses/cfn_mail_manager_ingress_point.rb', line 411

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:



423
424
425
426
# File 'ses/cfn_mail_manager_ingress_point.rb', line 423

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:



433
434
435
436
# File 'ses/cfn_mail_manager_ingress_point.rb', line 433

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.



444
445
446
447
448
# File 'ses/cfn_mail_manager_ingress_point.rb', line 444

def (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.


501
502
503
504
505
# File 'ses/cfn_mail_manager_ingress_point.rb', line 501

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.



511
512
513
514
# File 'ses/cfn_mail_manager_ingress_point.rb', line 511

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.



523
524
525
526
527
# File 'ses/cfn_mail_manager_ingress_point.rb', line 523

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:



536
537
538
539
# File 'ses/cfn_mail_manager_ingress_point.rb', line 536

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:



558
559
560
561
562
563
# File 'ses/cfn_mail_manager_ingress_point.rb', line 558

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

#attr_a_recordString

The DNS A Record that identifies your ingress endpoint.

Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

Returns:

  • (String)


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

def attr_a_record()
  jsii_get_property("attrARecord")
end

#attr_ingress_point_arnString

The Amazon Resource Name (ARN) of the ingress endpoint resource.

Returns:

  • (String)


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

def attr_ingress_point_arn()
  jsii_get_property("attrIngressPointArn")
end

#attr_ingress_point_idString

The identifier of the ingress endpoint resource.

Returns:

  • (String)


241
242
243
# File 'ses/cfn_mail_manager_ingress_point.rb', line 241

def attr_ingress_point_id()
  jsii_get_property("attrIngressPointId")
end

#attr_statusString

The status of the ingress endpoint resource.

Returns:

  • (String)


248
249
250
# File 'ses/cfn_mail_manager_ingress_point.rb', line 248

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



255
256
257
# File 'ses/cfn_mail_manager_ingress_point.rb', line 255

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


567
568
569
570
# File 'ses/cfn_mail_manager_ingress_point.rb', line 567

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


181
182
183
# File 'ses/cfn_mail_manager_ingress_point.rb', line 181

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


133
134
135
# File 'ses/cfn_mail_manager_ingress_point.rb', line 133

def creation_stack()
  jsii_get_property("creationStack")
end

#envAWSCDK::Interfaces::ResourceEnvironment



193
194
195
# File 'ses/cfn_mail_manager_ingress_point.rb', line 193

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:



580
581
582
583
584
# File 'ses/cfn_mail_manager_ingress_point.rb', line 580

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.



591
592
593
594
# File 'ses/cfn_mail_manager_ingress_point.rb', line 591

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

#ingress_point_configurationAWSCDK::IResolvable, ...

The configuration of the ingress endpoint resource.



305
306
307
# File 'ses/cfn_mail_manager_ingress_point.rb', line 305

def ingress_point_configuration()
  jsii_get_property("ingressPointConfiguration")
end

#ingress_point_configuration=(value) ⇒ Object



309
310
311
312
313
# File 'ses/cfn_mail_manager_ingress_point.rb', line 309

def ingress_point_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnMailManagerIngressPoint::IngressPointConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuTWFpbE1hbmFnZXJJbmdyZXNzUG9pbnQuSW5ncmVzc1BvaW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "ingressPointConfiguration") unless value.nil?
  jsii_set_property("ingressPointConfiguration", value)
end

#ingress_point_nameString?

A user friendly name for an ingress endpoint resource.

Returns:

  • (String, nil)


318
319
320
# File 'ses/cfn_mail_manager_ingress_point.rb', line 318

def ingress_point_name()
  jsii_get_property("ingressPointName")
end

#ingress_point_name=(value) ⇒ Object



322
323
324
325
# File 'ses/cfn_mail_manager_ingress_point.rb', line 322

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



661
662
663
664
# File 'ses/cfn_mail_manager_ingress_point.rb', line 661

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

#logical_idString

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)


145
146
147
# File 'ses/cfn_mail_manager_ingress_point.rb', line 145

def logical_id()
  jsii_get_property("logicalId")
end

#mail_manager_ingress_point_refAWSCDK::Interfaces::AWSSES::MailManagerIngressPointReference

A reference to a MailManagerIngressPoint resource.



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

def mail_manager_ingress_point_ref()
  jsii_get_property("mailManagerIngressPointRef")
end

#network_configurationAWSCDK::IResolvable, ...

The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.



330
331
332
# File 'ses/cfn_mail_manager_ingress_point.rb', line 330

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#network_configuration=(value) ⇒ Object



334
335
336
337
338
# File 'ses/cfn_mail_manager_ingress_point.rb', line 334

def network_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SES::CfnMailManagerIngressPoint::NetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuTWFpbE1hbmFnZXJJbmdyZXNzUG9pbnQuTmV0d29ya0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "networkConfiguration") unless value.nil?
  jsii_set_property("networkConfiguration", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


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

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



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

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



609
610
611
# File 'ses/cfn_mail_manager_ingress_point.rb', line 609

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.



402
403
404
405
# File 'ses/cfn_mail_manager_ingress_point.rb', line 402

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

#refString

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)


164
165
166
# File 'ses/cfn_mail_manager_ingress_point.rb', line 164

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:



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

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})


627
628
629
630
# File 'ses/cfn_mail_manager_ingress_point.rb', line 627

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:



637
638
639
640
641
# File 'ses/cfn_mail_manager_ingress_point.rb', line 637

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

#rule_set_idString

The identifier of an existing rule set that you attach to an ingress endpoint resource.

Returns:

  • (String)


269
270
271
# File 'ses/cfn_mail_manager_ingress_point.rb', line 269

def rule_set_id()
  jsii_get_property("ruleSetId")
end

#rule_set_id=(value) ⇒ Object



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

def rule_set_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleSetId")
  jsii_set_property("ruleSetId", value)
end

#should_synthesizeBoolean

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.



646
647
648
# File 'ses/cfn_mail_manager_ingress_point.rb', line 646

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



154
155
156
# File 'ses/cfn_mail_manager_ingress_point.rb', line 154

def stack()
  jsii_get_property("stack")
end

#status_to_updateString?

The update status of an ingress endpoint.

Returns:

  • (String, nil)


343
344
345
# File 'ses/cfn_mail_manager_ingress_point.rb', line 343

def status_to_update()
  jsii_get_property("statusToUpdate")
end

#status_to_update=(value) ⇒ Object



347
348
349
350
# File 'ses/cfn_mail_manager_ingress_point.rb', line 347

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

#tagsArray<AWSCDK::CfnTag>?

The tags used to organize, track, or control access for the resource.

Returns:



355
356
357
# File 'ses/cfn_mail_manager_ingress_point.rb', line 355

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



359
360
361
362
363
# File 'ses/cfn_mail_manager_ingress_point.rb', line 359

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

#tls_policyString?

Returns:

  • (String, nil)


366
367
368
# File 'ses/cfn_mail_manager_ingress_point.rb', line 366

def tls_policy()
  jsii_get_property("tlsPolicy")
end

#tls_policy=(value) ⇒ Object



370
371
372
373
# File 'ses/cfn_mail_manager_ingress_point.rb', line 370

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



378
379
380
# File 'ses/cfn_mail_manager_ingress_point.rb', line 378

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

#traffic_policy_idString

The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

Returns:

  • (String)


281
282
283
# File 'ses/cfn_mail_manager_ingress_point.rb', line 281

def traffic_policy_id()
  jsii_get_property("trafficPolicyId")
end

#traffic_policy_id=(value) ⇒ Object



285
286
287
288
# File 'ses/cfn_mail_manager_ingress_point.rb', line 285

def traffic_policy_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trafficPolicyId")
  jsii_set_property("trafficPolicyId", value)
end

#typeString

The type of the ingress endpoint to create.

Returns:

  • (String)


293
294
295
# File 'ses/cfn_mail_manager_ingress_point.rb', line 293

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object



297
298
299
300
# File 'ses/cfn_mail_manager_ingress_point.rb', line 297

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
end

#updated_properitesHash{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})


201
202
203
# File 'ses/cfn_mail_manager_ingress_point.rb', line 201

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


211
212
213
# File 'ses/cfn_mail_manager_ingress_point.rb', line 211

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


652
653
654
655
# File 'ses/cfn_mail_manager_ingress_point.rb', line 652

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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)


391
392
393
394
395
396
# File 'ses/cfn_mail_manager_ingress_point.rb', line 391

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