Class: AWSCDK::KinesisAnalyticsv2::CfnApplicationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_analyticsv2/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(runtime_environment:, service_execution_role:, application_configuration: nil, application_description: nil, application_maintenance_configuration: nil, application_mode: nil, application_name: nil, run_configuration: nil, tags: nil) ⇒ CfnApplicationProps

Returns a new instance of CfnApplicationProps.

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 18

def initialize(runtime_environment:, service_execution_role:, application_configuration: nil, application_description: nil, application_maintenance_configuration: nil, application_mode: nil, application_name: nil, run_configuration: nil, tags: nil)
  @runtime_environment = runtime_environment
  Jsii::Type.check_type(@runtime_environment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runtimeEnvironment")
  @service_execution_role = service_execution_role
  Jsii::Type.check_type(@service_execution_role, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "serviceExecutionRole")
  @application_configuration = application_configuration.is_a?(Hash) ? ::AWSCDK::KinesisAnalyticsv2::CfnApplication::ApplicationConfigurationProperty.new(**application_configuration.transform_keys(&:to_sym)) : application_configuration
  Jsii::Type.check_type(@application_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzdjIuQ2ZuQXBwbGljYXRpb24uQXBwbGljYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "applicationConfiguration") unless @application_configuration.nil?
  @application_description = application_description
  Jsii::Type.check_type(@application_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationDescription") unless @application_description.nil?
  @application_maintenance_configuration = application_maintenance_configuration.is_a?(Hash) ? ::AWSCDK::KinesisAnalyticsv2::CfnApplication::ApplicationMaintenanceConfigurationProperty.new(**application_maintenance_configuration.transform_keys(&:to_sym)) : application_maintenance_configuration
  Jsii::Type.check_type(@application_maintenance_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzdjIuQ2ZuQXBwbGljYXRpb24uQXBwbGljYXRpb25NYWludGVuYW5jZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "applicationMaintenanceConfiguration") unless @application_maintenance_configuration.nil?
  @application_mode = application_mode
  Jsii::Type.check_type(@application_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationMode") unless @application_mode.nil?
  @application_name = application_name
  Jsii::Type.check_type(@application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName") unless @application_name.nil?
  @run_configuration = run_configuration.is_a?(Hash) ? ::AWSCDK::KinesisAnalyticsv2::CfnApplication::RunConfigurationProperty.new(**run_configuration.transform_keys(&:to_sym)) : run_configuration
  Jsii::Type.check_type(@run_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzdjIuQ2ZuQXBwbGljYXRpb24uUnVuQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "runConfiguration") unless @run_configuration.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_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Use this parameter to configure the application.

Returns:

See Also:



53
54
55
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 53

def application_configuration
  @application_configuration
end

#application_description ⇒ String? (readonly)

Note:

Default: - ""

The description of the application.

Returns:

  • (String, nil)

See Also:



59
60
61
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 59

def application_description
  @application_description
end

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

Specifies the maintenance window parameters for a Kinesis Data Analytics application.

Returns:

See Also:



64
65
66
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 64

def application_maintenance_configuration
  @application_maintenance_configuration
end

#application_mode ⇒ String? (readonly)

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .

However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 71

def application_mode
  @application_mode
end

#application_name ⇒ String? (readonly)

The name of the application.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 76

def application_name
  @application_name
end

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

Describes the starting parameters for an Managed Service for Apache Flink application.

Returns:

See Also:



81
82
83
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 81

def run_configuration
  @run_configuration
end

#runtime_environment ⇒ String (readonly)

The runtime environment for the application.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 43

def runtime_environment
  @runtime_environment
end

#service_execution_role ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

Specifies the IAM role that the application uses to access external resources.

Returns:

See Also:



48
49
50
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 48

def service_execution_role
  @service_execution_role
end

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

A list of one or more tags to assign to the application.

A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

Returns:

See Also:



88
89
90
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 88

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 90

def self.jsii_properties
  {
    :runtime_environment => "runtimeEnvironment",
    :service_execution_role => "serviceExecutionRole",
    :application_configuration => "applicationConfiguration",
    :application_description => "applicationDescription",
    :application_maintenance_configuration => "applicationMaintenanceConfiguration",
    :application_mode => "applicationMode",
    :application_name => "applicationName",
    :run_configuration => "runConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'kinesis_analyticsv2/cfn_application_props.rb', line 104

def to_jsii
  result = {}
  result.merge!({
    "runtimeEnvironment" => @runtime_environment,
    "serviceExecutionRole" => @service_execution_role,
    "applicationConfiguration" => @application_configuration,
    "applicationDescription" => @application_description,
    "applicationMaintenanceConfiguration" => @application_maintenance_configuration,
    "applicationMode" => @application_mode,
    "applicationName" => @application_name,
    "runConfiguration" => @run_configuration,
    "tags" => @tags,
  })
  result.compact
end