Class: AWSCDK::Proton::CfnEnvironmentTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
proton/cfn_environment_template_props.rb

Overview

Properties for defining a CfnEnvironmentTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, display_name: nil, encryption_key: nil, name: nil, provisioning: nil, tags: nil) ⇒ CfnEnvironmentTemplateProps

Returns a new instance of CfnEnvironmentTemplateProps.

Parameters:

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

    A description of the environment template.

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

    The name of the environment template as displayed in the developer interface.

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

    The customer provided encryption key for the environment template.

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

    The name of the environment template.

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

    When included, indicates that the environment template is for customer provisioned and managed infrastructure.

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

    An optional list of metadata items that you can associate with the AWS Proton environment template.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'proton/cfn_environment_template_props.rb', line 15

def initialize(description: nil, display_name: nil, encryption_key: nil, name: nil, provisioning: nil, tags: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @encryption_key = encryption_key
  Jsii::Type.check_type(@encryption_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKey") unless @encryption_key.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @provisioning = provisioning
  Jsii::Type.check_type(@provisioning, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provisioning") unless @provisioning.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)

A description of the environment template.

Returns:

  • (String, nil)

See Also:



34
35
36
 
# File 'proton/cfn_environment_template_props.rb', line 34

def description
  @description
end

#display_name ⇒ String? (readonly)

The name of the environment template as displayed in the developer interface.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'proton/cfn_environment_template_props.rb', line 39

def display_name
  @display_name
end

#encryption_key ⇒ String? (readonly)

The customer provided encryption key for the environment template.

Returns:

  • (String, nil)

See Also:



44
45
46
 
# File 'proton/cfn_environment_template_props.rb', line 44

def encryption_key
  @encryption_key
end

#name ⇒ String? (readonly)

The name of the environment template.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'proton/cfn_environment_template_props.rb', line 49

def name
  @name
end

#provisioning ⇒ String? (readonly)

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'proton/cfn_environment_template_props.rb', line 54

def provisioning
  @provisioning
end

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

An optional list of metadata items that you can associate with the AWS Proton environment template.

A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide .

Returns:

See Also:



63
64
65
 
# File 'proton/cfn_environment_template_props.rb', line 63

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'proton/cfn_environment_template_props.rb', line 65

def self.jsii_properties
  {
    :description => "description",
    :display_name => "displayName",
    :encryption_key => "encryptionKey",
    :name => "name",
    :provisioning => "provisioning",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'proton/cfn_environment_template_props.rb', line 76

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "displayName" => @display_name,
    "encryptionKey" => @encryption_key,
    "name" => @name,
    "provisioning" => @provisioning,
    "tags" => @tags,
  })
  result.compact
end