Class: AWSCDK::IoTFleetHub::CfnApplicationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_fleet_hub/cfn_application_props.rb

Overview

Properties for defining a CfnApplication.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_name:, role_arn:, application_description: nil, tags: nil) ⇒ CfnApplicationProps

Returns a new instance of CfnApplicationProps.

Parameters:

  • application_name (String) —

    The name of the web application.

  • role_arn (String) —

    The ARN of the role that the web application assumes when it interacts with AWS IoT Core .

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

    An optional description of the web application.

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

    A set of key/value pairs that you can use to manage the web application resource.



13
14
15
16
17
18
19
20
21
22
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 13

def initialize(application_name:, role_arn:, application_description: nil, tags: nil)
  @application_name = application_name
  Jsii::Type.check_type(@application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @application_description = application_description
  Jsii::Type.check_type(@application_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationDescription") unless @application_description.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

#application_description ⇒ String? (readonly)

An optional description of the web application.

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 42

def application_description
  @application_description
end

#application_name ⇒ String (readonly)

The name of the web application.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 28

def application_name
  @application_name
end

#role_arn ⇒ String (readonly)

The ARN of the role that the web application assumes when it interacts with AWS IoT Core .

The name of the role must be in the form FleetHub_random_string .

Pattern: ^arn:[!-~]+$

Returns:

  • (String)

See Also:



37
38
39
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 37

def role_arn
  @role_arn
end

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

A set of key/value pairs that you can use to manage the web application resource.

Returns:

See Also:



47
48
49
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 47

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 49

def self.jsii_properties
  {
    :application_name => "applicationName",
    :role_arn => "roleArn",
    :application_description => "applicationDescription",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'io_t_fleet_hub/cfn_application_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "applicationName" => @application_name,
    "roleArn" => @role_arn,
    "applicationDescription" => @application_description,
    "tags" => @tags,
  })
  result.compact
end