Class: AWSCDK::DataZone::CfnEnvironmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_zone/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(domain_identifier:, name:, project_identifier:, deployment_order: nil, description: nil, environment_account_identifier: nil, environment_account_region: nil, environment_blueprint_identifier: nil, environment_configuration_id: nil, environment_profile_identifier: nil, environment_role_arn: nil, glossary_terms: nil, user_parameters: nil) ⇒ CfnEnvironmentProps

Returns a new instance of CfnEnvironmentProps.

Parameters:

  • domain_identifier (String) —

    The identifier of the Amazon DataZone domain in which the environment is created.

  • name (String) —

    The name of the Amazon DataZone environment.

  • project_identifier (String) —

    The identifier of the Amazon DataZone project in which this environment is created.

  • deployment_order (Numeric, nil) (defaults to: nil) —

    The deployment order for the environment.

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

    The description of the environment.

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

    The identifier of the AWS account in which an environment exists.

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

    The AWS Region in which an environment exists.

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

    The identifier of the environment blueprint.

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

    The identifier of the environment configuration.

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

    The identifier of the environment profile that is used to create this Amazon DataZone environment.

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

    The ARN of the environment role.

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

    The glossary terms that can be used in this Amazon DataZone environment.

  • user_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::DataZone::CfnEnvironment::EnvironmentParameterProperty>, nil) (defaults to: nil) —

    The user parameters of this Amazon DataZone environment.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'data_zone/cfn_environment_props.rb', line 22

def initialize(domain_identifier:, name:, project_identifier:, deployment_order: nil, description: nil, environment_account_identifier: nil, environment_account_region: nil, environment_blueprint_identifier: nil, environment_configuration_id: nil, environment_profile_identifier: nil, environment_role_arn: nil, glossary_terms: nil, user_parameters: nil)
  @domain_identifier = domain_identifier
  Jsii::Type.check_type(@domain_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainIdentifier")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @project_identifier = project_identifier
  Jsii::Type.check_type(@project_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectIdentifier")
  @deployment_order = deployment_order
  Jsii::Type.check_type(@deployment_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "deploymentOrder") unless @deployment_order.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @environment_account_identifier = 
  Jsii::Type.check_type(@environment_account_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentAccountIdentifier") unless @environment_account_identifier.nil?
  @environment_account_region = 
  Jsii::Type.check_type(@environment_account_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentAccountRegion") unless @environment_account_region.nil?
  @environment_blueprint_identifier = environment_blueprint_identifier
  Jsii::Type.check_type(@environment_blueprint_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentBlueprintIdentifier") unless @environment_blueprint_identifier.nil?
  @environment_configuration_id = environment_configuration_id
  Jsii::Type.check_type(@environment_configuration_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentConfigurationId") unless @environment_configuration_id.nil?
  @environment_profile_identifier = environment_profile_identifier
  Jsii::Type.check_type(@environment_profile_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentProfileIdentifier") unless @environment_profile_identifier.nil?
  @environment_role_arn = environment_role_arn
  Jsii::Type.check_type(@environment_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentRoleArn") unless @environment_role_arn.nil?
  @glossary_terms = glossary_terms
  Jsii::Type.check_type(@glossary_terms, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "glossaryTerms") unless @glossary_terms.nil?
  @user_parameters = user_parameters
  Jsii::Type.check_type(@user_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXpvbmUuQ2ZuRW52aXJvbm1lbnQuRW52aXJvbm1lbnRQYXJhbWV0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "userParameters") unless @user_parameters.nil?
end

Instance Attribute Details

#deployment_order ⇒ Numeric? (readonly)

The deployment order for the environment.

Returns:

  • (Numeric, nil)

See Also:



70
71
72
 
# File 'data_zone/cfn_environment_props.rb', line 70

def deployment_order
  @deployment_order
end

#description ⇒ String? (readonly)

The description of the environment.

Returns:

  • (String, nil)

See Also:



75
76
77
 
# File 'data_zone/cfn_environment_props.rb', line 75

def description
  @description
end

#domain_identifier ⇒ String (readonly)

The identifier of the Amazon DataZone domain in which the environment is created.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'data_zone/cfn_environment_props.rb', line 55

def domain_identifier
  @domain_identifier
end

#environment_account_identifier ⇒ String? (readonly)

The identifier of the AWS account in which an environment exists.

Returns:

  • (String, nil)

See Also:



80
81
82
 
# File 'data_zone/cfn_environment_props.rb', line 80

def 
  @environment_account_identifier
end

#environment_account_region ⇒ String? (readonly)

The AWS Region in which an environment exists.

Returns:

  • (String, nil)

See Also:



85
86
87
 
# File 'data_zone/cfn_environment_props.rb', line 85

def 
  @environment_account_region
end

#environment_blueprint_identifier ⇒ String? (readonly)

The identifier of the environment blueprint.

Returns:

  • (String, nil)

See Also:



90
91
92
 
# File 'data_zone/cfn_environment_props.rb', line 90

def environment_blueprint_identifier
  @environment_blueprint_identifier
end

#environment_configuration_id ⇒ String? (readonly)

The identifier of the environment configuration.

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'data_zone/cfn_environment_props.rb', line 95

def environment_configuration_id
  @environment_configuration_id
end

#environment_profile_identifier ⇒ String? (readonly)

The identifier of the environment profile that is used to create this Amazon DataZone environment.

Returns:

  • (String, nil)

See Also:



100
101
102
 
# File 'data_zone/cfn_environment_props.rb', line 100

def environment_profile_identifier
  @environment_profile_identifier
end

#environment_role_arn ⇒ String? (readonly)

The ARN of the environment role.

Returns:

  • (String, nil)

See Also:



105
106
107
 
# File 'data_zone/cfn_environment_props.rb', line 105

def environment_role_arn
  @environment_role_arn
end

#glossary_terms ⇒ Array<String>? (readonly)

The glossary terms that can be used in this Amazon DataZone environment.

Returns:

  • (Array<String>, nil)

See Also:



110
111
112
 
# File 'data_zone/cfn_environment_props.rb', line 110

def glossary_terms
  @glossary_terms
end

#name ⇒ String (readonly)

The name of the Amazon DataZone environment.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'data_zone/cfn_environment_props.rb', line 60

def name
  @name
end

#project_identifier ⇒ String (readonly)

The identifier of the Amazon DataZone project in which this environment is created.

Returns:

  • (String)

See Also:



65
66
67
 
# File 'data_zone/cfn_environment_props.rb', line 65

def project_identifier
  @project_identifier
end

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

The user parameters of this Amazon DataZone environment.

Returns:

See Also:



115
116
117
 
# File 'data_zone/cfn_environment_props.rb', line 115

def user_parameters
  @user_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'data_zone/cfn_environment_props.rb', line 117

def self.jsii_properties
  {
    :domain_identifier => "domainIdentifier",
    :name => "name",
    :project_identifier => "projectIdentifier",
    :deployment_order => "deploymentOrder",
    :description => "description",
    :environment_account_identifier => "environmentAccountIdentifier",
    :environment_account_region => "environmentAccountRegion",
    :environment_blueprint_identifier => "environmentBlueprintIdentifier",
    :environment_configuration_id => "environmentConfigurationId",
    :environment_profile_identifier => "environmentProfileIdentifier",
    :environment_role_arn => "environmentRoleArn",
    :glossary_terms => "glossaryTerms",
    :user_parameters => "userParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'data_zone/cfn_environment_props.rb', line 135

def to_jsii
  result = {}
  result.merge!({
    "domainIdentifier" => @domain_identifier,
    "name" => @name,
    "projectIdentifier" => @project_identifier,
    "deploymentOrder" => @deployment_order,
    "description" => @description,
    "environmentAccountIdentifier" => @environment_account_identifier,
    "environmentAccountRegion" => @environment_account_region,
    "environmentBlueprintIdentifier" => @environment_blueprint_identifier,
    "environmentConfigurationId" => @environment_configuration_id,
    "environmentProfileIdentifier" => @environment_profile_identifier,
    "environmentRoleArn" => @environment_role_arn,
    "glossaryTerms" => @glossary_terms,
    "userParameters" => @user_parameters,
  })
  result.compact
end