Class: AWSCDK::Connect::CfnInstanceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_instance_props.rb

Overview

Properties for defining a CfnInstance.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes:, identity_management_type:, directory_id: nil, instance_alias: nil, tags: nil) ⇒ CfnInstanceProps

Returns a new instance of CfnInstanceProps.

Parameters:

  • attributes (AWSCDK::IResolvable, AWSCDK::Connect::CfnInstance::AttributesProperty) —

    A toggle for an individual feature at the instance level.

  • identity_management_type (String) —

    The identity management type.

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

    The identifier for the directory.

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

    The alias of instance.

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

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



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'connect/cfn_instance_props.rb', line 14

def initialize(attributes:, identity_management_type:, directory_id: nil, instance_alias: nil, tags: nil)
  @attributes = attributes.is_a?(Hash) ? ::AWSCDK::Connect::CfnInstance::AttributesProperty.new(**attributes.transform_keys(&:to_sym)) : attributes
  Jsii::Type.check_type(@attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbkluc3RhbmNlLkF0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "attributes")
  @identity_management_type = identity_management_type
  Jsii::Type.check_type(@identity_management_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityManagementType")
  @directory_id = directory_id
  Jsii::Type.check_type(@directory_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryId") unless @directory_id.nil?
  @instance_alias = instance_alias
  Jsii::Type.check_type(@instance_alias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceAlias") unless @instance_alias.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

#attributes ⇒ AWSCDK::IResolvable, AWSCDK::Connect::CfnInstance::AttributesProperty (readonly)

A toggle for an individual feature at the instance level.

Returns:

See Also:



31
32
33
 
# File 'connect/cfn_instance_props.rb', line 31

def attributes
  @attributes
end

#directory_id ⇒ String? (readonly)

The identifier for the directory.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 'connect/cfn_instance_props.rb', line 41

def directory_id
  @directory_id
end

#identity_management_type ⇒ String (readonly)

The identity management type.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'connect/cfn_instance_props.rb', line 36

def identity_management_type
  @identity_management_type
end

#instance_alias ⇒ String? (readonly)

The alias of instance.

InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML . InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY .

Returns:

  • (String, nil)

See Also:



48
49
50
 
# File 'connect/cfn_instance_props.rb', line 48

def instance_alias
  @instance_alias
end

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

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

Returns:

See Also:



53
54
55
 
# File 'connect/cfn_instance_props.rb', line 53

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'connect/cfn_instance_props.rb', line 55

def self.jsii_properties
  {
    :attributes => "attributes",
    :identity_management_type => "identityManagementType",
    :directory_id => "directoryId",
    :instance_alias => "instanceAlias",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'connect/cfn_instance_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "attributes" => @attributes,
    "identityManagementType" => @identity_management_type,
    "directoryId" => @directory_id,
    "instanceAlias" => @instance_alias,
    "tags" => @tags,
  })
  result.compact
end