Class: AWSCDK::Pinpoint::CfnAPNSChannel

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSPinpoint::IAPNSChannelRef
Defined in:
pinpoint/cfn_apns_channel.rb

Overview

A channel is a type of platform that you can deliver messages to.

You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application.

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAPNSChannel

Create a new AWS::Pinpoint::APNSChannel.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Pinpoint::CfnAPNSChannelProps) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'pinpoint/cfn_apns_channel.rb', line 21

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


182
183
184
 
# File 'pinpoint/cfn_apns_channel.rb', line 182

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

.is_cfn_apns_channel(x) ⇒ Boolean

Checks whether the given object is a CfnAPNSChannel.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


84
85
86
87
 
# File 'pinpoint/cfn_apns_channel.rb', line 84

def self.is_cfn_apns_channel(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_pinpoint.CfnAPNSChannel", "isCfnAPNSChannel", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'pinpoint/cfn_apns_channel.rb', line 29

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 },
    :apns_channel_ref => { kind: :property, name: "apnsChannelRef", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :application_id => { kind: :property, name: "applicationId", is_optional: false },
    :bundle_id => { kind: :property, name: "bundleId", is_optional: true },
    :certificate => { kind: :property, name: "certificate", is_optional: true },
    :default_authentication_method => { kind: :property, name: "defaultAuthenticationMethod", is_optional: true },
    :enabled => { kind: :property, name: "enabled", is_optional: true },
    :private_key => { kind: :property, name: "privateKey", is_optional: true },
    :team_id => { kind: :property, name: "teamId", is_optional: true },
    :token_key => { kind: :property, name: "tokenKey", is_optional: true },
    :token_key_id => { kind: :property, name: "tokenKeyId", 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.



346
347
348
349
 
# File 'pinpoint/cfn_apns_channel.rb', line 346

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:



358
359
360
361
 
# File 'pinpoint/cfn_apns_channel.rb', line 358

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:



368
369
370
371
 
# File 'pinpoint/cfn_apns_channel.rb', line 368

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:



379
380
381
382
383
 
# File 'pinpoint/cfn_apns_channel.rb', line 379

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.


436
437
438
439
440
 
# File 'pinpoint/cfn_apns_channel.rb', line 436

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.



446
447
448
449
 
# File 'pinpoint/cfn_apns_channel.rb', line 446

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.



458
459
460
461
462
 
# File 'pinpoint/cfn_apns_channel.rb', line 458

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

#apns_channel_ref ⇒ AWSCDK::Interfaces::AWSPinpoint::APNSChannelReference

A reference to a APNSChannel resource.

Returns:



189
190
191
 
# File 'pinpoint/cfn_apns_channel.rb', line 189

def apns_channel_ref()
  jsii_get_property("apnsChannelRef")
end

#application_id ⇒ String

The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.

Returns:

  • (String) 


205
206
207
 
# File 'pinpoint/cfn_apns_channel.rb', line 205

def application_id()
  jsii_get_property("applicationId")
end

#application_id=(value) ⇒ Object 



209
210
211
212
 
# File 'pinpoint/cfn_apns_channel.rb', line 209

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



471
472
473
474
 
# File 'pinpoint/cfn_apns_channel.rb', line 471

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:



493
494
495
496
497
498
 
# File 'pinpoint/cfn_apns_channel.rb', line 493

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

(Deprecated) An identifier for the APNs channel.

This property is retained only for backward compatibility.

Returns:

  • (String) 


198
199
200
 
# File 'pinpoint/cfn_apns_channel.rb', line 198

def attr_id()
  jsii_get_property("attrId")
end

#bundle_id ⇒ String?

The bundle identifier that's assigned to your iOS app.

Returns:

  • (String, nil) 


217
218
219
 
# File 'pinpoint/cfn_apns_channel.rb', line 217

def bundle_id()
  jsii_get_property("bundleId")
end

#bundle_id=(value) ⇒ Object 



221
222
223
224
 
# File 'pinpoint/cfn_apns_channel.rb', line 221

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

#certificate ⇒ String?

The APNs client certificate that you received from Apple.

Returns:

  • (String, nil) 


229
230
231
 
# File 'pinpoint/cfn_apns_channel.rb', line 229

def certificate()
  jsii_get_property("certificate")
end

#certificate=(value) ⇒ Object 



233
234
235
236
 
# File 'pinpoint/cfn_apns_channel.rb', line 233

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



135
136
137
 
# File 'pinpoint/cfn_apns_channel.rb', line 135

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


140
141
142
 
# File 'pinpoint/cfn_apns_channel.rb', line 140

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


502
503
504
505
 
# File 'pinpoint/cfn_apns_channel.rb', line 502

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


145
146
147
 
# File 'pinpoint/cfn_apns_channel.rb', line 145

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


152
153
154
 
# File 'pinpoint/cfn_apns_channel.rb', line 152

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


97
98
99
 
# File 'pinpoint/cfn_apns_channel.rb', line 97

def creation_stack()
  jsii_get_property("creationStack")
end

#default_authentication_method ⇒ String?

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Returns:

  • (String, nil) 


241
242
243
 
# File 'pinpoint/cfn_apns_channel.rb', line 241

def default_authentication_method()
  jsii_get_property("defaultAuthenticationMethod")
end

#default_authentication_method=(value) ⇒ Object 



245
246
247
248
 
# File 'pinpoint/cfn_apns_channel.rb', line 245

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

#enabled ⇒ Boolean, ...

Specifies whether to enable the APNs channel for the application.

Returns:



253
254
255
 
# File 'pinpoint/cfn_apns_channel.rb', line 253

def enabled()
  jsii_get_property("enabled")
end

#enabled=(value) ⇒ Object 



257
258
259
260
 
# File 'pinpoint/cfn_apns_channel.rb', line 257

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



157
158
159
 
# File 'pinpoint/cfn_apns_channel.rb', line 157

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:



515
516
517
518
519
 
# File 'pinpoint/cfn_apns_channel.rb', line 515

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:



526
527
528
529
 
# File 'pinpoint/cfn_apns_channel.rb', line 526

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:



596
597
598
599
 
# File 'pinpoint/cfn_apns_channel.rb', line 596

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) 


109
110
111
 
# File 'pinpoint/cfn_apns_channel.rb', line 109

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


92
93
94
 
# File 'pinpoint/cfn_apns_channel.rb', line 92

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:



537
538
539
 
# File 'pinpoint/cfn_apns_channel.rb', line 537

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:



544
545
546
 
# File 'pinpoint/cfn_apns_channel.rb', line 544

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.



337
338
339
340
 
# File 'pinpoint/cfn_apns_channel.rb', line 337

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

#private_key ⇒ String?

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

Returns:

  • (String, nil) 


265
266
267
 
# File 'pinpoint/cfn_apns_channel.rb', line 265

def private_key()
  jsii_get_property("privateKey")
end

#private_key=(value) ⇒ Object 



269
270
271
272
 
# File 'pinpoint/cfn_apns_channel.rb', line 269

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


128
129
130
 
# File 'pinpoint/cfn_apns_channel.rb', line 128

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:



555
556
557
558
 
# File 'pinpoint/cfn_apns_channel.rb', line 555

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


562
563
564
565
 
# File 'pinpoint/cfn_apns_channel.rb', line 562

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:



572
573
574
575
576
 
# File 'pinpoint/cfn_apns_channel.rb', line 572

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

#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.



581
582
583
 
# File 'pinpoint/cfn_apns_channel.rb', line 581

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:



118
119
120
 
# File 'pinpoint/cfn_apns_channel.rb', line 118

def stack()
  jsii_get_property("stack")
end

#team_id ⇒ String?

The identifier that's assigned to your Apple Developer Account team.

Returns:

  • (String, nil) 


277
278
279
 
# File 'pinpoint/cfn_apns_channel.rb', line 277

def team_id()
  jsii_get_property("teamId")
end

#team_id=(value) ⇒ Object 



281
282
283
284
 
# File 'pinpoint/cfn_apns_channel.rb', line 281

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



313
314
315
 
# File 'pinpoint/cfn_apns_channel.rb', line 313

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

#token_key ⇒ String?

The authentication key to use for APNs tokens.

Returns:

  • (String, nil) 


289
290
291
 
# File 'pinpoint/cfn_apns_channel.rb', line 289

def token_key()
  jsii_get_property("tokenKey")
end

#token_key=(value) ⇒ Object 



293
294
295
296
 
# File 'pinpoint/cfn_apns_channel.rb', line 293

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

#token_key_id ⇒ String?

The key identifier that's assigned to your APNs signing key.

Returns:

  • (String, nil) 


301
302
303
 
# File 'pinpoint/cfn_apns_channel.rb', line 301

def token_key_id()
  jsii_get_property("tokenKeyId")
end

#token_key_id=(value) ⇒ Object 



305
306
307
308
 
# File 'pinpoint/cfn_apns_channel.rb', line 305

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


165
166
167
 
# File 'pinpoint/cfn_apns_channel.rb', line 165

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


175
176
177
 
# File 'pinpoint/cfn_apns_channel.rb', line 175

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


587
588
589
590
 
# File 'pinpoint/cfn_apns_channel.rb', line 587

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) 


326
327
328
329
330
331
 
# File 'pinpoint/cfn_apns_channel.rb', line 326

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