Class: AWSCDK::Pinpoint::CfnAPNSChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_apns_channel_props.rb

Overview

Properties for defining a CfnAPNSChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, bundle_id: nil, certificate: nil, default_authentication_method: nil, enabled: nil, private_key: nil, team_id: nil, token_key: nil, token_key_id: nil) ⇒ CfnAPNSChannelProps

Returns a new instance of CfnAPNSChannelProps.

Parameters:

  • application_id (String) —

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

  • bundle_id (String, nil) (defaults to: nil) —

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

  • certificate (String, nil) (defaults to: nil) —

    The APNs client certificate that you received from Apple.

  • default_authentication_method (String, nil) (defaults to: nil) —

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

  • enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to enable the APNs channel for the application.

  • private_key (String, nil) (defaults to: nil) —

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

  • team_id (String, nil) (defaults to: nil) —

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

  • token_key (String, nil) (defaults to: nil) —

    The authentication key to use for APNs tokens.

  • token_key_id (String, nil) (defaults to: nil) —

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 18

def initialize(application_id:, bundle_id: nil, certificate: nil, default_authentication_method: nil, enabled: nil, private_key: nil, team_id: nil, token_key: nil, token_key_id: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @bundle_id = bundle_id
  Jsii::Type.check_type(@bundle_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bundleId") unless @bundle_id.nil?
  @certificate = certificate
  Jsii::Type.check_type(@certificate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificate") unless @certificate.nil?
  @default_authentication_method = default_authentication_method
  Jsii::Type.check_type(@default_authentication_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultAuthenticationMethod") unless @default_authentication_method.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey") unless @private_key.nil?
  @team_id = team_id
  Jsii::Type.check_type(@team_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamId") unless @team_id.nil?
  @token_key = token_key
  Jsii::Type.check_type(@token_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tokenKey") unless @token_key.nil?
  @token_key_id = token_key_id
  Jsii::Type.check_type(@token_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tokenKeyId") unless @token_key_id.nil?
end

Instance Attribute Details

#application_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



43
44
45
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 43

def application_id
  @application_id
end

#bundle_id ⇒ String? (readonly)

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

This identifier is used for APNs tokens.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 50

def bundle_id
  @bundle_id
end

#certificate ⇒ String? (readonly)

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 57

def certificate
  @certificate
end

#default_authentication_method ⇒ String? (readonly)

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

Valid options are key or certificate .

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 64

def default_authentication_method
  @default_authentication_method
end

#enabled ⇒ Boolean, ... (readonly)

Specifies whether to enable the APNs channel for the application.

Returns:

See Also:



69
70
71
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 69

def enabled
  @enabled
end

#private_key ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 74

def private_key
  @private_key
end

#team_id ⇒ String? (readonly)

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

This identifier is used for APNs tokens.

Returns:

  • (String, nil)

See Also:



81
82
83
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 81

def team_id
  @team_id
end

#token_key ⇒ String? (readonly)

The authentication key to use for APNs tokens.

Returns:

  • (String, nil)

See Also:



86
87
88
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 86

def token_key
  @token_key
end

#token_key_id ⇒ String? (readonly)

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

Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 93

def token_key_id
  @token_key_id
end

Class Method Details

.jsii_properties ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 95

def self.jsii_properties
  {
    :application_id => "applicationId",
    :bundle_id => "bundleId",
    :certificate => "certificate",
    :default_authentication_method => "defaultAuthenticationMethod",
    :enabled => "enabled",
    :private_key => "privateKey",
    :team_id => "teamId",
    :token_key => "tokenKey",
    :token_key_id => "tokenKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'pinpoint/cfn_apns_channel_props.rb', line 109

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "bundleId" => @bundle_id,
    "certificate" => @certificate,
    "defaultAuthenticationMethod" => @default_authentication_method,
    "enabled" => @enabled,
    "privateKey" => @private_key,
    "teamId" => @team_id,
    "tokenKey" => @token_key,
    "tokenKeyId" => @token_key_id,
  })
  result.compact
end