Class: AWSCDK::IVS::CfnPlaybackKeyPairProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ivs/cfn_playback_key_pair_props.rb

Overview

Properties for defining a CfnPlaybackKeyPair.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, public_key_material: nil, tags: nil) ⇒ CfnPlaybackKeyPairProps

Returns a new instance of CfnPlaybackKeyPairProps.

Parameters:

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

    Playback-key-pair name.

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

    The public portion of a customer-generated key pair.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



12
13
14
15
16
17
18
19
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 12

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

Instance Attribute Details

#name ⇒ String? (readonly)

Playback-key-pair name.

The value does not need to be unique.

Returns:

  • (String, nil)

See Also:



27
28
29
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 27

def name
  @name
end

#public_key_material ⇒ String? (readonly)

The public portion of a customer-generated key pair.

Note that this field is required to create the AWS::IVS::PlaybackKeyPair resource.

Returns:

  • (String, nil)

See Also:



34
35
36
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 34

def public_key_material
  @public_key_material
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



41
42
43
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 41

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 43

def self.jsii_properties
  {
    :name => "name",
    :public_key_material => "publicKeyMaterial",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'ivs/cfn_playback_key_pair_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "publicKeyMaterial" => @public_key_material,
    "tags" => @tags,
  })
  result.compact
end