Class: AWSCDK::ServiceCatalog::PortfolioProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
service_catalog/portfolio_props.rb

Overview

Properties for a Portfolio.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(display_name:, provider_name:, description: nil, message_language: nil, tag_options: nil) ⇒ PortfolioProps

Returns a new instance of PortfolioProps.

Parameters:

  • display_name (String) —

    The name of the portfolio.

  • provider_name (String) —

    The provider name.

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

    Description for portfolio.

  • message_language (AWSCDK::ServiceCatalog::MessageLanguage, nil) (defaults to: nil) —

    The message language.

  • tag_options (AWSCDK::ServiceCatalog::TagOptions, nil) (defaults to: nil) —

    TagOptions associated directly to a portfolio.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'service_catalog/portfolio_props.rb', line 12

def initialize(display_name:, provider_name:, description: nil, message_language: nil, tag_options: nil)
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @provider_name = provider_name
  Jsii::Type.check_type(@provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "providerName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @message_language = message_language
  Jsii::Type.check_type(@message_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuTWVzc2FnZUxhbmd1YWdlIn0=")), "messageLanguage") unless @message_language.nil?
  @tag_options = tag_options
  Jsii::Type.check_type(@tag_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuVGFnT3B0aW9ucyJ9")), "tagOptions") unless @tag_options.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - No description provided

Description for portfolio.

Returns:

  • (String, nil) 


37
38
39
 
# File 'service_catalog/portfolio_props.rb', line 37

def description
  @description
end

#display_name ⇒ String (readonly)

The name of the portfolio.

Returns:

  • (String) 


28
29
30
 
# File 'service_catalog/portfolio_props.rb', line 28

def display_name
  @display_name
end

#message_language ⇒ AWSCDK::ServiceCatalog::MessageLanguage? (readonly)

Note:

Default: - English

The message language.

Controls language for status logging and errors.

Returns:



45
46
47
 
# File 'service_catalog/portfolio_props.rb', line 45

def message_language
  @message_language
end

#provider_name ⇒ String (readonly)

The provider name.

Returns:

  • (String) 


32
33
34
 
# File 'service_catalog/portfolio_props.rb', line 32

def provider_name
  @provider_name
end

#tag_options ⇒ AWSCDK::ServiceCatalog::TagOptions? (readonly)

Note:

Default: - No tagOptions provided

TagOptions associated directly to a portfolio.

Returns:



50
51
52
 
# File 'service_catalog/portfolio_props.rb', line 50

def tag_options
  @tag_options
end

Class Method Details

.jsii_properties ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'service_catalog/portfolio_props.rb', line 52

def self.jsii_properties
  {
    :display_name => "displayName",
    :provider_name => "providerName",
    :description => "description",
    :message_language => "messageLanguage",
    :tag_options => "tagOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'service_catalog/portfolio_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "displayName" => @display_name,
    "providerName" => @provider_name,
    "description" => @description,
    "messageLanguage" => @message_language,
    "tagOptions" => @tag_options,
  })
  result.compact
end