Class: AWSCDK::DataZone::CfnProjectProps

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

Overview

Properties for defining a CfnProject.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_identifier:, name:, description: nil, domain_unit_id: nil, glossary_terms: nil, membership_assignments: nil, project_category: nil, project_execution_role: nil, project_profile_id: nil, project_profile_version: nil, resource_tags: nil, user_parameters: nil) ⇒ CfnProjectProps

Returns a new instance of CfnProjectProps.

Parameters:



21
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
 
# File 'data_zone/cfn_project_props.rb', line 21

def initialize(domain_identifier:, name:, description: nil, domain_unit_id: nil, glossary_terms: nil, membership_assignments: nil, project_category: nil, project_execution_role: nil, project_profile_id: nil, project_profile_version: nil, resource_tags: 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")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @domain_unit_id = domain_unit_id
  Jsii::Type.check_type(@domain_unit_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainUnitId") unless @domain_unit_id.nil?
  @glossary_terms = glossary_terms
  Jsii::Type.check_type(@glossary_terms, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "glossaryTerms") unless @glossary_terms.nil?
  @membership_assignments = membership_assignments
  Jsii::Type.check_type(@membership_assignments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXpvbmUuQ2ZuUHJvamVjdC5Qcm9qZWN0TWVtYmVyc2hpcEFzc2lnbm1lbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "membershipAssignments") unless @membership_assignments.nil?
  @project_category = project_category
  Jsii::Type.check_type(@project_category, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectCategory") unless @project_category.nil?
  @project_execution_role = project_execution_role
  Jsii::Type.check_type(@project_execution_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectExecutionRole") unless @project_execution_role.nil?
  @project_profile_id = project_profile_id
  Jsii::Type.check_type(@project_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectProfileId") unless @project_profile_id.nil?
  @project_profile_version = project_profile_version
  Jsii::Type.check_type(@project_profile_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectProfileVersion") unless @project_profile_version.nil?
  @resource_tags = resource_tags
  Jsii::Type.check_type(@resource_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXpvbmUuQ2ZuUHJvamVjdC5SZXNvdXJjZVRhZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "resourceTags") unless @resource_tags.nil?
  @user_parameters = user_parameters
  Jsii::Type.check_type(@user_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXpvbmUuQ2ZuUHJvamVjdC5FbnZpcm9ubWVudENvbmZpZ3VyYXRpb25Vc2VyUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "userParameters") unless @user_parameters.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of a project.

Returns:

  • (String, nil)

See Also:



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

def description
  @description
end

#domain_identifier ⇒ String (readonly)

The identifier of a Amazon DataZone domain where the project exists.

Returns:

  • (String)

See Also:



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

def domain_identifier
  @domain_identifier
end

#domain_unit_id ⇒ String? (readonly)

The ID of the domain unit.

This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

Returns:

  • (String, nil)

See Also:



69
70
71
 
# File 'data_zone/cfn_project_props.rb', line 69

def domain_unit_id
  @domain_unit_id
end

#glossary_terms ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



74
75
76
 
# File 'data_zone/cfn_project_props.rb', line 74

def glossary_terms
  @glossary_terms
end

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

The project membership assignments.

Returns:

See Also:



79
80
81
 
# File 'data_zone/cfn_project_props.rb', line 79

def membership_assignments
  @membership_assignments
end

#name ⇒ String (readonly)

The name of a project.

Returns:

  • (String)

See Also:



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

def name
  @name
end

#project_category ⇒ String? (readonly)

The project category.

Returns:

  • (String, nil)

See Also:



84
85
86
 
# File 'data_zone/cfn_project_props.rb', line 84

def project_category
  @project_category
end

#project_execution_role ⇒ String? (readonly)

The project execution role ARN.

Returns:

  • (String, nil)

See Also:



89
90
91
 
# File 'data_zone/cfn_project_props.rb', line 89

def project_execution_role
  @project_execution_role
end

#project_profile_id ⇒ String? (readonly)

The ID of the project profile.

Returns:

  • (String, nil)

See Also:



94
95
96
 
# File 'data_zone/cfn_project_props.rb', line 94

def project_profile_id
  @project_profile_id
end

#project_profile_version ⇒ String? (readonly)

The project profile version to which the project should be updated.

You can only specify the following string for this parameter: latest .

Returns:

  • (String, nil)

See Also:



101
102
103
 
# File 'data_zone/cfn_project_props.rb', line 101

def project_profile_version
  @project_profile_version
end

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

The resource tags of the project.

Returns:

See Also:



106
107
108
 
# File 'data_zone/cfn_project_props.rb', line 106

def resource_tags
  @resource_tags
end

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

The user parameters of the project.

Returns:

See Also:



111
112
113
 
# File 'data_zone/cfn_project_props.rb', line 111

def user_parameters
  @user_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'data_zone/cfn_project_props.rb', line 113

def self.jsii_properties
  {
    :domain_identifier => "domainIdentifier",
    :name => "name",
    :description => "description",
    :domain_unit_id => "domainUnitId",
    :glossary_terms => "glossaryTerms",
    :membership_assignments => "membershipAssignments",
    :project_category => "projectCategory",
    :project_execution_role => "projectExecutionRole",
    :project_profile_id => "projectProfileId",
    :project_profile_version => "projectProfileVersion",
    :resource_tags => "resourceTags",
    :user_parameters => "userParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'data_zone/cfn_project_props.rb', line 130

def to_jsii
  result = {}
  result.merge!({
    "domainIdentifier" => @domain_identifier,
    "name" => @name,
    "description" => @description,
    "domainUnitId" => @domain_unit_id,
    "glossaryTerms" => @glossary_terms,
    "membershipAssignments" => @membership_assignments,
    "projectCategory" => @project_category,
    "projectExecutionRole" => @project_execution_role,
    "projectProfileId" => @project_profile_id,
    "projectProfileVersion" => @project_profile_version,
    "resourceTags" => @resource_tags,
    "userParameters" => @user_parameters,
  })
  result.compact
end