Class: AWSCDK::FinSpace::CfnEnvironmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fin_space/cfn_environment_props.rb

Overview

Properties for defining a CfnEnvironment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, data_bundles: nil, description: nil, federation_mode: nil, federation_parameters: nil, kms_key_id: nil, superuser_parameters: nil, tags: nil) ⇒ CfnEnvironmentProps

Returns a new instance of CfnEnvironmentProps.

Parameters:

  • name (String) —

    The name of the FinSpace environment.

  • data_bundles (Array<String>, nil) (defaults to: nil) —

    ARNs of FinSpace Data Bundles to install.

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

    The description of the FinSpace environment.

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

    The authentication mode for the environment.

  • federation_parameters (AWSCDK::IResolvable, AWSCDK::FinSpace::CfnEnvironment::FederationParametersProperty, nil) (defaults to: nil) —

    Configuration information when authentication mode is FEDERATED.

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

    The KMS key id used to encrypt in the FinSpace environment.

  • superuser_parameters (AWSCDK::IResolvable, AWSCDK::FinSpace::CfnEnvironment::SuperuserParametersProperty, nil) (defaults to: nil) —

    Configuration information for the superuser.

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

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



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'fin_space/cfn_environment_props.rb', line 17

def initialize(name:, data_bundles: nil, description: nil, federation_mode: nil, federation_parameters: nil, kms_key_id: nil, superuser_parameters: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @data_bundles = data_bundles
  Jsii::Type.check_type(@data_bundles, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dataBundles") unless @data_bundles.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @federation_mode = federation_mode
  Jsii::Type.check_type(@federation_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "federationMode") unless @federation_mode.nil?
  @federation_parameters = federation_parameters.is_a?(Hash) ? ::AWSCDK::FinSpace::CfnEnvironment::FederationParametersProperty.new(**federation_parameters.transform_keys(&:to_sym)) : federation_parameters
  Jsii::Type.check_type(@federation_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19maW5zcGFjZS5DZm5FbnZpcm9ubWVudC5GZWRlcmF0aW9uUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "federationParameters") unless @federation_parameters.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @superuser_parameters = superuser_parameters.is_a?(Hash) ? ::AWSCDK::FinSpace::CfnEnvironment::SuperuserParametersProperty.new(**superuser_parameters.transform_keys(&:to_sym)) : superuser_parameters
  Jsii::Type.check_type(@superuser_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19maW5zcGFjZS5DZm5FbnZpcm9ubWVudC5TdXBlcnVzZXJQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "superuserParameters") unless @superuser_parameters.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

#data_bundles ⇒ Array<String>? (readonly)

Deprecated.

this property has been deprecated

ARNs of FinSpace Data Bundles to install.

Returns:

  • (Array<String>, nil)

See Also:



46
47
48
 
# File 'fin_space/cfn_environment_props.rb', line 46

def data_bundles
  @data_bundles
end

#description ⇒ String? (readonly)

The description of the FinSpace environment.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'fin_space/cfn_environment_props.rb', line 51

def description
  @description
end

#federation_mode ⇒ String? (readonly)

The authentication mode for the environment.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'fin_space/cfn_environment_props.rb', line 56

def federation_mode
  @federation_mode
end

#federation_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information when authentication mode is FEDERATED.

Returns:

See Also:



61
62
63
 
# File 'fin_space/cfn_environment_props.rb', line 61

def federation_parameters
  @federation_parameters
end

#kms_key_id ⇒ String? (readonly)

The KMS key id used to encrypt in the FinSpace environment.

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'fin_space/cfn_environment_props.rb', line 66

def kms_key_id
  @kms_key_id
end

#name ⇒ String (readonly)

The name of the FinSpace environment.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'fin_space/cfn_environment_props.rb', line 40

def name
  @name
end

#superuser_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for the superuser.

Returns:

See Also:



71
72
73
 
# File 'fin_space/cfn_environment_props.rb', line 71

def superuser_parameters
  @superuser_parameters
end

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

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

Returns:

See Also:



76
77
78
 
# File 'fin_space/cfn_environment_props.rb', line 76

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'fin_space/cfn_environment_props.rb', line 78

def self.jsii_properties
  {
    :name => "name",
    :data_bundles => "dataBundles",
    :description => "description",
    :federation_mode => "federationMode",
    :federation_parameters => "federationParameters",
    :kms_key_id => "kmsKeyId",
    :superuser_parameters => "superuserParameters",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'fin_space/cfn_environment_props.rb', line 91

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "dataBundles" => @data_bundles,
    "description" => @description,
    "federationMode" => @federation_mode,
    "federationParameters" => @federation_parameters,
    "kmsKeyId" => @kms_key_id,
    "superuserParameters" => @superuser_parameters,
    "tags" => @tags,
  })
  result.compact
end