Class: AWSCDK::KinesisAnalytics::CfnApplicationV2 Deprecated
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::KinesisAnalytics::CfnApplicationV2
- Includes:
- IInspectable, ITaggable, Interfaces::AWSKinesisanalyticsv2::IApplicationRef
- Defined in:
- kinesis_analytics/cfn_application_v2.rb
Overview
use aws-kinesisanalyticsv2 instead
Creates an Amazon Kinesis Data Analytics application.
For information about creating a Kinesis Data Analytics application, see Creating an Application .
Class Method Summary collapse
- .arn_for_application(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_application_name(scope, id, application_name) ⇒ AWSCDK::Interfaces::AWSKinesisanalyticsv2::IApplicationRef
Creates a new IApplicationRef from a applicationName.
-
.is_cfn_application_v2(x) ⇒ Boolean
Checks whether the given object is a CfnApplicationV2.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#application_configuration ⇒ AWSCDK::IResolvable, ...
Use this parameter to configure the application.
- #application_configuration=(value) ⇒ Object
-
#application_description ⇒ String?
The description of the application.
- #application_description=(value) ⇒ Object
-
#application_maintenance_configuration ⇒ AWSCDK::IResolvable, ...
Specifies the maintenance window parameters for a Kinesis Data Analytics application.
- #application_maintenance_configuration=(value) ⇒ Object
-
#application_mode ⇒ String?
To create a Kinesis Data Analytics Studio notebook, you must set the mode to
INTERACTIVE. - #application_mode=(value) ⇒ Object
-
#application_name ⇒ String?
The name of the application.
- #application_name=(value) ⇒ Object
-
#application_ref ⇒ AWSCDK::Interfaces::AWSKinesisanalyticsv2::ApplicationReference
A reference to a Application resource.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnApplicationV2
constructor
Create a new
AWS::KinesisAnalyticsV2::Application. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#run_configuration ⇒ AWSCDK::IResolvable, ...
Describes the starting parameters for an Managed Service for Apache Flink application.
- #run_configuration=(value) ⇒ Object
-
#runtime_environment ⇒ String
The runtime environment for the application.
- #runtime_environment=(value) ⇒ Object
-
#service_execution_role ⇒ String
Specifies the IAM role that the application uses to access external resources.
- #service_execution_role=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of one or more tags to assign to the application.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnApplicationV2
Create a new AWS::KinesisAnalyticsV2::Application.
21 22 23 24 25 26 27 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 21 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::KinesisAnalytics::CfnApplicationV2Props.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2FuYWx5dGljcy5DZm5BcHBsaWNhdGlvblYyUHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_application(resource) ⇒ String
82 83 84 85 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 82 def self.arn_for_application(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19raW5lc2lzYW5hbHl0aWNzdjIuSUFwcGxpY2F0aW9uUmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2", "arnForApplication", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
202 203 204 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 202 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2", "CFN_RESOURCE_TYPE_NAME") end |
.from_application_name(scope, id, application_name) ⇒ AWSCDK::Interfaces::AWSKinesisanalyticsv2::IApplicationRef
Creates a new IApplicationRef from a applicationName.
93 94 95 96 97 98 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 93 def self.from_application_name(scope, id, application_name) Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2", "fromApplicationName", [scope, id, application_name]) end |
.is_cfn_application_v2(x) ⇒ Boolean
Checks whether the given object is a CfnApplicationV2.
104 105 106 107 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 104 def self.is_cfn_application_v2(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2", "isCfnApplicationV2", [x]) end |
.jsii_overridable_methods ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 29 def self.jsii_overridable_methods { :node => { kind: :property, name: "node", is_optional: false }, :creation_stack => { kind: :property, name: "creationStack", is_optional: false }, :logical_id => { kind: :property, name: "logicalId", is_optional: false }, :stack => { kind: :property, name: "stack", is_optional: false }, :ref => { kind: :property, name: "ref", is_optional: false }, :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false }, :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false }, :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false }, :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false }, :env => { kind: :property, name: "env", is_optional: false }, :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false }, :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false }, :application_ref => { kind: :property, name: "applicationRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :runtime_environment => { kind: :property, name: "runtimeEnvironment", is_optional: false }, :service_execution_role => { kind: :property, name: "serviceExecutionRole", is_optional: false }, :application_configuration => { kind: :property, name: "applicationConfiguration", is_optional: true }, :application_description => { kind: :property, name: "applicationDescription", is_optional: true }, :application_maintenance_configuration => { kind: :property, name: "applicationMaintenanceConfiguration", is_optional: true }, :application_mode => { kind: :property, name: "applicationMode", is_optional: true }, :application_name => { kind: :property, name: "applicationName", is_optional: true }, :run_configuration => { kind: :property, name: "runConfiguration", is_optional: true }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true }, :to_string => { kind: :method, name: "toString", is_optional: false }, :with => { kind: :method, name: "with", is_optional: false }, :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false }, :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false }, :add_dependency => { kind: :method, name: "addDependency", is_optional: false }, :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false }, :add_metadata => { kind: :method, name: "addMetadata", is_optional: false }, :add_override => { kind: :method, name: "addOverride", is_optional: false }, :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false }, :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false }, :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false }, :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false }, :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false }, :get_att => { kind: :method, name: "getAtt", is_optional: false }, :get_metadata => { kind: :method, name: "getMetadata", is_optional: false }, :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false }, :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false }, :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false }, :render_properties => { kind: :method, name: "renderProperties", is_optional: false }, :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false }, :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false }, :validate_properties => { kind: :method, name: "validateProperties", is_optional: false }, :inspect => { kind: :method, name: "inspect", is_optional: false }, } end |
Instance Method Details
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
368 369 370 371 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 368 def add_deletion_override(path) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") jsii_call_method("addDeletionOverride", [path]) end |
#add_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
380 381 382 383 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 380 def add_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependency", [target]) end |
#add_depends_on(target) ⇒ void
use addDependency
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
390 391 392 393 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 390 def add_depends_on(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependsOn", [target]) end |
#add_metadata(key, value) ⇒ void
This method returns an undefined value.
Add a value to the CloudFormation Resource Metadata.
401 402 403 404 405 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 401 def (key, value) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addMetadata", [key, value]) end |
#add_override(path, value) ⇒ void
This method returns an undefined value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use add_property_override or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
\ itself will need to be escaped.
For example,
# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to add_override will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
458 459 460 461 462 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 458 def add_override(path, value) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addOverride", [path, value]) end |
#add_property_deletion_override(property_path) ⇒ void
This method returns an undefined value.
Adds an override that deletes the value of a property from the resource definition.
468 469 470 471 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 468 def add_property_deletion_override(property_path) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") jsii_call_method("addPropertyDeletionOverride", [property_path]) end |
#add_property_override(property_path, value) ⇒ void
This method returns an undefined value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
480 481 482 483 484 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 480 def add_property_override(property_path, value) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addPropertyOverride", [property_path, value]) end |
#application_configuration ⇒ AWSCDK::IResolvable, ...
Use this parameter to configure the application.
247 248 249 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 247 def application_configuration() jsii_get_property("applicationConfiguration") end |
#application_configuration=(value) ⇒ Object
251 252 253 254 255 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 251 def application_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::KinesisAnalytics::CfnApplicationV2::ApplicationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzLkNmbkFwcGxpY2F0aW9uVjIuQXBwbGljYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "applicationConfiguration") unless value.nil? jsii_set_property("applicationConfiguration", value) end |
#application_description ⇒ String?
The description of the application.
260 261 262 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 260 def application_description() jsii_get_property("applicationDescription") end |
#application_description=(value) ⇒ Object
264 265 266 267 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 264 def application_description=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationDescription") unless value.nil? jsii_set_property("applicationDescription", value) end |
#application_maintenance_configuration ⇒ AWSCDK::IResolvable, ...
Specifies the maintenance window parameters for a Kinesis Data Analytics application.
272 273 274 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 272 def application_maintenance_configuration() jsii_get_property("applicationMaintenanceConfiguration") end |
#application_maintenance_configuration=(value) ⇒ Object
276 277 278 279 280 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 276 def application_maintenance_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::KinesisAnalytics::CfnApplicationV2::ApplicationMaintenanceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzLkNmbkFwcGxpY2F0aW9uVjIuQXBwbGljYXRpb25NYWludGVuYW5jZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "applicationMaintenanceConfiguration") unless value.nil? jsii_set_property("applicationMaintenanceConfiguration", value) end |
#application_mode ⇒ String?
To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE .
285 286 287 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 285 def application_mode() jsii_get_property("applicationMode") end |
#application_mode=(value) ⇒ Object
289 290 291 292 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 289 def application_mode=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationMode") unless value.nil? jsii_set_property("applicationMode", value) end |
#application_name ⇒ String?
The name of the application.
297 298 299 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 297 def application_name() jsii_get_property("applicationName") end |
#application_name=(value) ⇒ Object
301 302 303 304 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 301 def application_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName") unless value.nil? jsii_set_property("applicationName", value) end |
#application_ref ⇒ AWSCDK::Interfaces::AWSKinesisanalyticsv2::ApplicationReference
A reference to a Application resource.
209 210 211 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 209 def application_ref() jsii_get_property("applicationRef") end |
#apply_cross_stack_reference_strength(strength) ⇒ void
This method returns an undefined value.
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
493 494 495 496 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 493 def apply_cross_stack_reference_strength(strength) Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength") jsii_call_method("applyCrossStackReferenceStrength", [strength]) end |
#apply_removal_policy(policy = nil, options = nil) ⇒ void
This method returns an undefined value.
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
515 516 517 518 519 520 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 515 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
155 156 157 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 155 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
160 161 162 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 160 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
524 525 526 527 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 524 def cfn_property_name(cdk_property_name) Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName") jsii_call_method("cfnPropertyName", [cdk_property_name]) end |
#cfn_property_names ⇒ Hash{String => String}
165 166 167 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 165 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
172 173 174 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 172 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
117 118 119 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 117 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
177 178 179 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 177 def env() jsii_get_property("env") end |
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
537 538 539 540 541 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 537 def get_att(attribute_name, type_hint = nil) Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil? jsii_call_method("getAtt", [attribute_name, type_hint]) end |
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
548 549 550 551 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 548 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
618 619 620 621 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 618 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use override_logical_id(new_logical_id).
129 130 131 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 129 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
112 113 114 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 112 def node() jsii_get_property("node") end |
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
559 560 561 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 559 def obtain_dependencies() jsii_call_method("obtainDependencies", []) end |
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
566 567 568 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 566 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
359 360 361 362 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 359 def override_logical_id(new_logical_id) Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId") jsii_call_method("overrideLogicalId", [new_logical_id]) end |
#ref ⇒ String
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
148 149 150 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 148 def ref() jsii_get_property("ref") end |
#remove_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
577 578 579 580 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 577 def remove_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("removeDependency", [target]) end |
#render_properties(props) ⇒ Hash{String => Object}
584 585 586 587 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 584 def render_properties(props) Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") jsii_call_method("renderProperties", [props]) end |
#replace_dependency(target, new_target) ⇒ void
This method returns an undefined value.
Replaces one dependency with another.
594 595 596 597 598 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 594 def replace_dependency(target, new_target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget") jsii_call_method("replaceDependency", [target, new_target]) end |
#run_configuration ⇒ AWSCDK::IResolvable, ...
Describes the starting parameters for an Managed Service for Apache Flink application.
309 310 311 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 309 def run_configuration() jsii_get_property("runConfiguration") end |
#run_configuration=(value) ⇒ Object
313 314 315 316 317 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 313 def run_configuration=(value) value = value.is_a?(Hash) ? ::AWSCDK::KinesisAnalytics::CfnApplicationV2::RunConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzYW5hbHl0aWNzLkNmbkFwcGxpY2F0aW9uVjIuUnVuQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "runConfiguration") unless value.nil? jsii_set_property("runConfiguration", value) end |
#runtime_environment ⇒ String
The runtime environment for the application.
223 224 225 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 223 def runtime_environment() jsii_get_property("runtimeEnvironment") end |
#runtime_environment=(value) ⇒ Object
227 228 229 230 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 227 def runtime_environment=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "runtimeEnvironment") jsii_set_property("runtimeEnvironment", value) end |
#service_execution_role ⇒ String
Specifies the IAM role that the application uses to access external resources.
235 236 237 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 235 def service_execution_role() jsii_get_property("serviceExecutionRole") end |
#service_execution_role=(value) ⇒ Object
239 240 241 242 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 239 def service_execution_role=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceExecutionRole") jsii_set_property("serviceExecutionRole", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
603 604 605 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 603 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
138 139 140 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 138 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
216 217 218 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 216 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of one or more tags to assign to the application.
322 323 324 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 322 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
326 327 328 329 330 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 326 def (value) value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil? jsii_set_property("tagsRaw", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
335 336 337 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 335 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Deprecated.
185 186 187 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 185 def updated_properites() jsii_get_property("updatedProperites") end |
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
195 196 197 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 195 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
609 610 611 612 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 609 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
348 349 350 351 352 353 |
# File 'kinesis_analytics/cfn_application_v2.rb', line 348 def with(*mixins) mixins.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]") end jsii_call_method("with", [*mixins]) end |