Class: AWSCDK::DataZone::CfnDomainProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_zone/cfn_domain_props.rb

Overview

Properties for defining a CfnDomain.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, description: nil, domain_execution_role: nil, domain_version: nil, kms_key_identifier: nil, service_role: nil, single_sign_on: nil, tags: nil) ⇒ CfnDomainProps

Returns a new instance of CfnDomainProps.

Parameters:

  • name (String) —

    The name of the Amazon DataZone domain.

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

    The description of the Amazon DataZone domain.

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

    The domain execution role that is created when an Amazon DataZone domain is created.

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

    The domain version.

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

    The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

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

    The service role of the domain.

  • single_sign_on (AWSCDK::IResolvable, AWSCDK::DataZone::CfnDomain::SingleSignOnProperty, nil) (defaults to: nil) —

    The single sign-on details in Amazon DataZone.

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

    The tags specified for the Amazon DataZone domain.



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

def initialize(name:, description: nil, domain_execution_role: nil, domain_version: nil, kms_key_identifier: nil, service_role: nil, single_sign_on: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @domain_execution_role = domain_execution_role
  Jsii::Type.check_type(@domain_execution_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainExecutionRole") unless @domain_execution_role.nil?
  @domain_version = domain_version
  Jsii::Type.check_type(@domain_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainVersion") unless @domain_version.nil?
  @kms_key_identifier = kms_key_identifier
  Jsii::Type.check_type(@kms_key_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless @kms_key_identifier.nil?
  @service_role = service_role
  Jsii::Type.check_type(@service_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRole") unless @service_role.nil?
  @single_sign_on = single_sign_on.is_a?(Hash) ? ::AWSCDK::DataZone::CfnDomain::SingleSignOnProperty.new(**single_sign_on.transform_keys(&:to_sym)) : single_sign_on
  Jsii::Type.check_type(@single_sign_on, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhem9uZS5DZm5Eb21haW4uU2luZ2xlU2lnbk9uUHJvcGVydHkifV19fQ==")), "singleSignOn") unless @single_sign_on.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

#description ⇒ String? (readonly)

The description of the Amazon DataZone domain.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'data_zone/cfn_domain_props.rb', line 45

def description
  @description
end

#domain_execution_role ⇒ String? (readonly)

The domain execution role that is created when an Amazon DataZone domain is created.

The domain execution role is created in the AWS account that houses the Amazon DataZone domain.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'data_zone/cfn_domain_props.rb', line 52

def domain_execution_role
  @domain_execution_role
end

#domain_version ⇒ String? (readonly)

The domain version.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'data_zone/cfn_domain_props.rb', line 57

def domain_version
  @domain_version
end

#kms_key_identifier ⇒ String? (readonly)

The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'data_zone/cfn_domain_props.rb', line 62

def kms_key_identifier
  @kms_key_identifier
end

#name ⇒ String (readonly)

The name of the Amazon DataZone domain.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'data_zone/cfn_domain_props.rb', line 40

def name
  @name
end

#service_role ⇒ String? (readonly)

The service role of the domain.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'data_zone/cfn_domain_props.rb', line 67

def service_role
  @service_role
end

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

The single sign-on details in Amazon DataZone.

Returns:

See Also:



72
73
74
 
# File 'data_zone/cfn_domain_props.rb', line 72

def single_sign_on
  @single_sign_on
end

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

The tags specified for the Amazon DataZone domain.

Returns:

See Also:



77
78
79
 
# File 'data_zone/cfn_domain_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'data_zone/cfn_domain_props.rb', line 79

def self.jsii_properties
  {
    :name => "name",
    :description => "description",
    :domain_execution_role => "domainExecutionRole",
    :domain_version => "domainVersion",
    :kms_key_identifier => "kmsKeyIdentifier",
    :service_role => "serviceRole",
    :single_sign_on => "singleSignOn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'data_zone/cfn_domain_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "description" => @description,
    "domainExecutionRole" => @domain_execution_role,
    "domainVersion" => @domain_version,
    "kmsKeyIdentifier" => @kms_key_identifier,
    "serviceRole" => @service_role,
    "singleSignOn" => @single_sign_on,
    "tags" => @tags,
  })
  result.compact
end