Class: AWSCDK::SMSVoice::CfnPhoneNumber

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSmsvoice::IPhoneNumberRef
Defined in:
sms_voice/cfn_phone_number.rb

Overview

Request an origination phone number for use in your account.

For more information on phone number request see Request a phone number in the End User Messaging User Guide .

Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPhoneNumber

Create a new AWS::SMSVOICE::PhoneNumber.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::SMSVoice::CfnPhoneNumberProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'sms_voice/cfn_phone_number.rb', line 22

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

Class Method Details

.arn_for_phone_number(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'sms_voice/cfn_phone_number.rb', line 87

def self.arn_for_phone_number(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zbXN2b2ljZS5JUGhvbmVOdW1iZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_smsvoice.CfnPhoneNumber", "arnForPhoneNumber", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


220
221
222
 
# File 'sms_voice/cfn_phone_number.rb', line 220

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

.from_phone_number_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSSmsvoice::IPhoneNumberRef

Creates a new IPhoneNumberRef from an ARN.

Parameters:

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

Returns:



98
99
100
101
102
103
 
# File 'sms_voice/cfn_phone_number.rb', line 98

def self.from_phone_number_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_smsvoice.CfnPhoneNumber", "fromPhoneNumberArn", [scope, id, arn])
end

.from_phone_number_id(scope, id, phone_number_id) ⇒ AWSCDK::Interfaces::AWSSmsvoice::IPhoneNumberRef

Creates a new IPhoneNumberRef from a phoneNumberId.

Parameters:

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

Returns:



111
112
113
114
115
116
 
# File 'sms_voice/cfn_phone_number.rb', line 111

def self.from_phone_number_id(scope, id, phone_number_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(phone_number_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "phoneNumberId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_smsvoice.CfnPhoneNumber", "fromPhoneNumberId", [scope, id, phone_number_id])
end

.is_cfn_phone_number(x) ⇒ Boolean

Checks whether the given object is a CfnPhoneNumber.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


122
123
124
125
 
# File 'sms_voice/cfn_phone_number.rb', line 122

def self.is_cfn_phone_number(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_smsvoice.CfnPhoneNumber", "isCfnPhoneNumber", [x])
end

.jsii_overridable_methods ⇒ Object 



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
82
83
 
# File 'sms_voice/cfn_phone_number.rb', line 30

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_phone_number => { kind: :property, name: "attrPhoneNumber", is_optional: false },
    :attr_phone_number_id => { kind: :property, name: "attrPhoneNumberId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :phone_number_ref => { kind: :property, name: "phoneNumberRef", is_optional: false },
    :iso_country_code => { kind: :property, name: "isoCountryCode", is_optional: false },
    :mandatory_keywords => { kind: :property, name: "mandatoryKeywords", is_optional: false },
    :number_capabilities => { kind: :property, name: "numberCapabilities", is_optional: false },
    :number_type => { kind: :property, name: "numberType", is_optional: false },
    :deletion_protection_enabled => { kind: :property, name: "deletionProtectionEnabled", is_optional: true },
    :optional_keywords => { kind: :property, name: "optionalKeywords", is_optional: true },
    :opt_out_list_name => { kind: :property, name: "optOutListName", is_optional: true },
    :self_managed_opt_outs_enabled => { kind: :property, name: "selfManagedOptOutsEnabled", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :two_way => { kind: :property, name: "twoWay", 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.



418
419
420
421
 
# File 'sms_voice/cfn_phone_number.rb', line 418

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:



430
431
432
433
 
# File 'sms_voice/cfn_phone_number.rb', line 430

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:



440
441
442
443
 
# File 'sms_voice/cfn_phone_number.rb', line 440

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:



451
452
453
454
455
 
# File 'sms_voice/cfn_phone_number.rb', line 451

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.


508
509
510
511
512
 
# File 'sms_voice/cfn_phone_number.rb', line 508

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.



518
519
520
521
 
# File 'sms_voice/cfn_phone_number.rb', line 518

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.



530
531
532
533
534
 
# File 'sms_voice/cfn_phone_number.rb', line 530

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:



543
544
545
546
 
# File 'sms_voice/cfn_phone_number.rb', line 543

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:



565
566
567
568
569
570
 
# File 'sms_voice/cfn_phone_number.rb', line 565

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_arn ⇒ String

The PhoneNumber 's Amazon Resource Name (ARN).

Returns:

  • (String) 


227
228
229
 
# File 'sms_voice/cfn_phone_number.rb', line 227

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_phone_number ⇒ String

The phone number in E.164 format.

Returns:

  • (String) 


234
235
236
 
# File 'sms_voice/cfn_phone_number.rb', line 234

def attr_phone_number()
  jsii_get_property("attrPhoneNumber")
end

#attr_phone_number_id ⇒ String

The unique identifier for the phone number.

Returns:

  • (String) 


241
242
243
 
# File 'sms_voice/cfn_phone_number.rb', line 241

def attr_phone_number_id()
  jsii_get_property("attrPhoneNumberId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



248
249
250
 
# File 'sms_voice/cfn_phone_number.rb', line 248

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



173
174
175
 
# File 'sms_voice/cfn_phone_number.rb', line 173

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'sms_voice/cfn_phone_number.rb', line 178

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


574
575
576
577
 
# File 'sms_voice/cfn_phone_number.rb', line 574

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


183
184
185
 
# File 'sms_voice/cfn_phone_number.rb', line 183

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


190
191
192
 
# File 'sms_voice/cfn_phone_number.rb', line 190

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


135
136
137
 
# File 'sms_voice/cfn_phone_number.rb', line 135

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection_enabled ⇒ Boolean, ...

By default this is set to false.

Returns:



311
312
313
 
# File 'sms_voice/cfn_phone_number.rb', line 311

def deletion_protection_enabled()
  jsii_get_property("deletionProtectionEnabled")
end

#deletion_protection_enabled=(value) ⇒ Object 



315
316
317
318
 
# File 'sms_voice/cfn_phone_number.rb', line 315

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



195
196
197
 
# File 'sms_voice/cfn_phone_number.rb', line 195

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:



587
588
589
590
591
 
# File 'sms_voice/cfn_phone_number.rb', line 587

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:



598
599
600
601
 
# File 'sms_voice/cfn_phone_number.rb', line 598

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:



668
669
670
671
 
# File 'sms_voice/cfn_phone_number.rb', line 668

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

#iso_country_code ⇒ String

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

  • (String) 


262
263
264
 
# File 'sms_voice/cfn_phone_number.rb', line 262

def iso_country_code()
  jsii_get_property("isoCountryCode")
end

#iso_country_code=(value) ⇒ Object 



266
267
268
269
 
# File 'sms_voice/cfn_phone_number.rb', line 266

def iso_country_code=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "isoCountryCode")
  jsii_set_property("isoCountryCode", value)
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) 


147
148
149
 
# File 'sms_voice/cfn_phone_number.rb', line 147

def logical_id()
  jsii_get_property("logicalId")
end

#mandatory_keywords ⇒ AWSCDK::IResolvable, AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordsProperty

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

Returns:



274
275
276
 
# File 'sms_voice/cfn_phone_number.rb', line 274

def mandatory_keywords()
  jsii_get_property("mandatoryKeywords")
end

#mandatory_keywords=(value) ⇒ Object 



278
279
280
281
282
 
# File 'sms_voice/cfn_phone_number.rb', line 278

def mandatory_keywords=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbXN2b2ljZS5DZm5QaG9uZU51bWJlci5NYW5kYXRvcnlLZXl3b3Jkc1Byb3BlcnR5In1dfX0=")), "mandatoryKeywords")
  jsii_set_property("mandatoryKeywords", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


130
131
132
 
# File 'sms_voice/cfn_phone_number.rb', line 130

def node()
  jsii_get_property("node")
end

#number_capabilities ⇒ Array<String>

Indicates if the phone number will be used for text messages, voice messages, or both.

Returns:

  • (Array<String>) 


287
288
289
 
# File 'sms_voice/cfn_phone_number.rb', line 287

def number_capabilities()
  jsii_get_property("numberCapabilities")
end

#number_capabilities=(value) ⇒ Object 



291
292
293
294
 
# File 'sms_voice/cfn_phone_number.rb', line 291

def number_capabilities=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "numberCapabilities")
  jsii_set_property("numberCapabilities", value)
end

#number_type ⇒ String

The type of phone number to request.

Returns:

  • (String) 


299
300
301
 
# File 'sms_voice/cfn_phone_number.rb', line 299

def number_type()
  jsii_get_property("numberType")
end

#number_type=(value) ⇒ Object 



303
304
305
306
 
# File 'sms_voice/cfn_phone_number.rb', line 303

def number_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "numberType")
  jsii_set_property("numberType", value)
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:



609
610
611
 
# File 'sms_voice/cfn_phone_number.rb', line 609

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:



616
617
618
 
# File 'sms_voice/cfn_phone_number.rb', line 616

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

#opt_out_list_name ⇒ String?

The name of the OptOutList associated with the phone number.

Returns:

  • (String, nil) 


335
336
337
 
# File 'sms_voice/cfn_phone_number.rb', line 335

def opt_out_list_name()
  jsii_get_property("optOutListName")
end

#opt_out_list_name=(value) ⇒ Object 



339
340
341
342
 
# File 'sms_voice/cfn_phone_number.rb', line 339

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

#optional_keywords ⇒ AWSCDK::IResolvable, ...

A keyword is a word that you can search for on a particular phone number or pool.

Returns:



323
324
325
 
# File 'sms_voice/cfn_phone_number.rb', line 323

def optional_keywords()
  jsii_get_property("optionalKeywords")
end

#optional_keywords=(value) ⇒ Object 



327
328
329
330
 
# File 'sms_voice/cfn_phone_number.rb', line 327

def optional_keywords=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc21zdm9pY2UuQ2ZuUGhvbmVOdW1iZXIuT3B0aW9uYWxLZXl3b3JkUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "optionalKeywords") unless value.nil?
  jsii_set_property("optionalKeywords", value)
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.



409
410
411
412
 
# File 'sms_voice/cfn_phone_number.rb', line 409

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

#phone_number_ref ⇒ AWSCDK::Interfaces::AWSSmsvoice::PhoneNumberReference

A reference to a PhoneNumber resource.

Returns:



255
256
257
 
# File 'sms_voice/cfn_phone_number.rb', line 255

def phone_number_ref()
  jsii_get_property("phoneNumberRef")
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) 


166
167
168
 
# File 'sms_voice/cfn_phone_number.rb', line 166

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:



627
628
629
630
 
# File 'sms_voice/cfn_phone_number.rb', line 627

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


634
635
636
637
 
# File 'sms_voice/cfn_phone_number.rb', line 634

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:



644
645
646
647
648
 
# File 'sms_voice/cfn_phone_number.rb', line 644

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

#self_managed_opt_outs_enabled ⇒ Boolean, ...

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.

Returns:



347
348
349
 
# File 'sms_voice/cfn_phone_number.rb', line 347

def self_managed_opt_outs_enabled()
  jsii_get_property("selfManagedOptOutsEnabled")
end

#self_managed_opt_outs_enabled=(value) ⇒ Object 



351
352
353
354
 
# File 'sms_voice/cfn_phone_number.rb', line 351

def self_managed_opt_outs_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "selfManagedOptOutsEnabled") unless value.nil?
  jsii_set_property("selfManagedOptOutsEnabled", 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.



653
654
655
 
# File 'sms_voice/cfn_phone_number.rb', line 653

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:



156
157
158
 
# File 'sms_voice/cfn_phone_number.rb', line 156

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of tags (key and value pairs) to associate with the requested phone number.

Returns:



359
360
361
 
# File 'sms_voice/cfn_phone_number.rb', line 359

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



363
364
365
366
367
 
# File 'sms_voice/cfn_phone_number.rb', line 363

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



385
386
387
 
# File 'sms_voice/cfn_phone_number.rb', line 385

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

#two_way ⇒ AWSCDK::IResolvable, ...

Describes the two-way SMS configuration for a phone number.

Returns:



372
373
374
 
# File 'sms_voice/cfn_phone_number.rb', line 372

def two_way()
  jsii_get_property("twoWay")
end

#two_way=(value) ⇒ Object 



376
377
378
379
380
 
# File 'sms_voice/cfn_phone_number.rb', line 376

def two_way=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SMSVoice::CfnPhoneNumber::TwoWayProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbXN2b2ljZS5DZm5QaG9uZU51bWJlci5Ud29XYXlQcm9wZXJ0eSJ9XX19")), "twoWay") unless value.nil?
  jsii_set_property("twoWay", 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}) 


203
204
205
 
# File 'sms_voice/cfn_phone_number.rb', line 203

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


213
214
215
 
# File 'sms_voice/cfn_phone_number.rb', line 213

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


659
660
661
662
 
# File 'sms_voice/cfn_phone_number.rb', line 659

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) 


398
399
400
401
402
403
 
# File 'sms_voice/cfn_phone_number.rb', line 398

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