Class: AWSCDK::KinesisFirehose::CfnDeliveryStream

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSKinesisfirehose::IDeliveryStreamRef
Defined in:
kinesis_firehose/cfn_delivery_stream.rb

Overview

The AWS::KinesisFirehose::DeliveryStream resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination.

For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDeliveryStream

Create a new AWS::KinesisFirehose::DeliveryStream.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::KinesisFirehose::CfnDeliveryStreamProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStreamProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLkNmbkRlbGl2ZXJ5U3RyZWFtUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_delivery_stream(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 91

def self.arn_for_delivery_stream(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19raW5lc2lzZmlyZWhvc2UuSURlbGl2ZXJ5U3RyZWFtUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream", "arnForDeliveryStream", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


224
225
226
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 224

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream", "CFN_RESOURCE_TYPE_NAME")
end

.from_delivery_stream_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSKinesisfirehose::IDeliveryStreamRef

Creates a new IDeliveryStreamRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



102
103
104
105
106
107
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 102

def self.from_delivery_stream_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream", "fromDeliveryStreamArn", [scope, id, arn])
end

.from_delivery_stream_name(scope, id, delivery_stream_name) ⇒ AWSCDK::Interfaces::AWSKinesisfirehose::IDeliveryStreamRef

Creates a new IDeliveryStreamRef from a deliveryStreamName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • delivery_stream_name (String)

Returns:



115
116
117
118
119
120
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 115

def self.from_delivery_stream_name(scope, id, delivery_stream_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(delivery_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream", "fromDeliveryStreamName", [scope, id, delivery_stream_name])
end

.is_cfn_delivery_stream(x) ⇒ Boolean

Checks whether the given object is a CfnDeliveryStream.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


126
127
128
129
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 126

def self.is_cfn_delivery_stream(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream", "isCfnDeliveryStream", [x])
end

.jsii_overridable_methods ⇒ Object 



28
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
79
80
81
82
83
84
85
86
87
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 28

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 },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :delivery_stream_ref => { kind: :property, name: "deliveryStreamRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :amazon_open_search_serverless_destination_configuration => { kind: :property, name: "amazonOpenSearchServerlessDestinationConfiguration", is_optional: true },
    :amazonopensearchservice_destination_configuration => { kind: :property, name: "amazonopensearchserviceDestinationConfiguration", is_optional: true },
    :database_source_configuration => { kind: :property, name: "databaseSourceConfiguration", is_optional: true },
    :delivery_stream_encryption_configuration_input => { kind: :property, name: "deliveryStreamEncryptionConfigurationInput", is_optional: true },
    :delivery_stream_name => { kind: :property, name: "deliveryStreamName", is_optional: true },
    :delivery_stream_type => { kind: :property, name: "deliveryStreamType", is_optional: true },
    :direct_put_source_configuration => { kind: :property, name: "directPutSourceConfiguration", is_optional: true },
    :elasticsearch_destination_configuration => { kind: :property, name: "elasticsearchDestinationConfiguration", is_optional: true },
    :extended_s3_destination_configuration => { kind: :property, name: "extendedS3DestinationConfiguration", is_optional: true },
    :http_endpoint_destination_configuration => { kind: :property, name: "httpEndpointDestinationConfiguration", is_optional: true },
    :iceberg_destination_configuration => { kind: :property, name: "icebergDestinationConfiguration", is_optional: true },
    :kinesis_stream_source_configuration => { kind: :property, name: "kinesisStreamSourceConfiguration", is_optional: true },
    :msk_source_configuration => { kind: :property, name: "mskSourceConfiguration", is_optional: true },
    :redshift_destination_configuration => { kind: :property, name: "redshiftDestinationConfiguration", is_optional: true },
    :s3_destination_configuration => { kind: :property, name: "s3DestinationConfiguration", is_optional: true },
    :snowflake_destination_configuration => { kind: :property, name: "snowflakeDestinationConfiguration", is_optional: true },
    :splunk_destination_configuration => { kind: :property, name: "splunkDestinationConfiguration", 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).

Parameters:

  • path (String) —

    The path of the value to delete.



519
520
521
522
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 519

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.

Parameters:



531
532
533
534
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 531

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

Deprecated.

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.

Parameters:



541
542
543
544
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 541

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



552
553
554
555
556
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 552

def add_metadata(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.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


609
610
611
612
613
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 609

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.

Parameters:

  • property_path (String) —

    The path to the property.



619
620
621
622
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 619

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).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



631
632
633
634
635
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 631

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

#amazon_open_search_serverless_destination_configuration ⇒ AWSCDK::IResolvable, ...

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Returns:



252
253
254
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 252

def amazon_open_search_serverless_destination_configuration()
  jsii_get_property("amazonOpenSearchServerlessDestinationConfiguration")
end

#amazon_open_search_serverless_destination_configuration=(value) ⇒ Object 



256
257
258
259
260
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 256

def amazon_open_search_serverless_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonOpenSearchServerlessDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9uT3BlblNlYXJjaFNlcnZlcmxlc3NEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "amazonOpenSearchServerlessDestinationConfiguration") unless value.nil?
  jsii_set_property("amazonOpenSearchServerlessDestinationConfiguration", value)
end

#amazonopensearchservice_destination_configuration ⇒ AWSCDK::IResolvable, ...

The destination in Amazon OpenSearch Service.

Returns:



265
266
267
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 265

def amazonopensearchservice_destination_configuration()
  jsii_get_property("amazonopensearchserviceDestinationConfiguration")
end

#amazonopensearchservice_destination_configuration=(value) ⇒ Object 



269
270
271
272
273
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 269

def amazonopensearchservice_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonopensearchserviceDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9ub3BlbnNlYXJjaHNlcnZpY2VEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "amazonopensearchserviceDestinationConfiguration") unless value.nil?
  jsii_set_property("amazonopensearchserviceDestinationConfiguration", value)
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.

Parameters:



644
645
646
647
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 644

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:

Parameters:

See Also:



666
667
668
669
670
671
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 666

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .

Returns:

  • (String) 


231
232
233
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 231

def attr_arn()
  jsii_get_property("attrArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



177
178
179
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 177

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


182
183
184
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 182

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


675
676
677
678
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 675

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}

Returns:

  • (Hash{String => String}) 


187
188
189
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 187

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


194
195
196
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 194

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


139
140
141
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 139

def creation_stack()
  jsii_get_property("creationStack")
end

#database_source_configuration ⇒ AWSCDK::IResolvable, ...

The top level object for configuring streams with database as a source.

Returns:



278
279
280
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 278

def database_source_configuration()
  jsii_get_property("databaseSourceConfiguration")
end

#database_source_configuration=(value) ⇒ Object 



282
283
284
285
286
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 282

def database_source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DatabaseSourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGF0YWJhc2VTb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "databaseSourceConfiguration") unless value.nil?
  jsii_set_property("databaseSourceConfiguration", value)
end

#delivery_stream_encryption_configuration_input ⇒ AWSCDK::IResolvable, ...

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

Returns:



291
292
293
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 291

def delivery_stream_encryption_configuration_input()
  jsii_get_property("deliveryStreamEncryptionConfigurationInput")
end

#delivery_stream_encryption_configuration_input=(value) ⇒ Object 



295
296
297
298
299
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 295

def delivery_stream_encryption_configuration_input=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DeliveryStreamEncryptionConfigurationInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGVsaXZlcnlTdHJlYW1FbmNyeXB0aW9uQ29uZmlndXJhdGlvbklucHV0UHJvcGVydHkifV19fQ==")), "deliveryStreamEncryptionConfigurationInput") unless value.nil?
  jsii_set_property("deliveryStreamEncryptionConfigurationInput", value)
end

#delivery_stream_name ⇒ String?

The name of the Firehose stream.

Returns:

  • (String, nil) 


304
305
306
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 304

def delivery_stream_name()
  jsii_get_property("deliveryStreamName")
end

#delivery_stream_name=(value) ⇒ Object 



308
309
310
311
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 308

def delivery_stream_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamName") unless value.nil?
  jsii_set_property("deliveryStreamName", value)
end

#delivery_stream_ref ⇒ AWSCDK::Interfaces::AWSKinesisfirehose::DeliveryStreamReference

A reference to a DeliveryStream resource.

Returns:



238
239
240
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 238

def delivery_stream_ref()
  jsii_get_property("deliveryStreamRef")
end

#delivery_stream_type ⇒ String?

The Firehose stream type.

This can be one of the following values:.

Returns:

  • (String, nil) 


318
319
320
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 318

def delivery_stream_type()
  jsii_get_property("deliveryStreamType")
end

#delivery_stream_type=(value) ⇒ Object 



322
323
324
325
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 322

def delivery_stream_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamType") unless value.nil?
  jsii_set_property("deliveryStreamType", value)
end

#direct_put_source_configuration ⇒ AWSCDK::IResolvable, ...

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Returns:



330
331
332
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 330

def direct_put_source_configuration()
  jsii_get_property("directPutSourceConfiguration")
end

#direct_put_source_configuration=(value) ⇒ Object 



334
335
336
337
338
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 334

def direct_put_source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DirectPutSourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGlyZWN0UHV0U291cmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "directPutSourceConfiguration") unless value.nil?
  jsii_set_property("directPutSourceConfiguration", value)
end

#elasticsearch_destination_configuration ⇒ AWSCDK::IResolvable, ...

An Amazon ES destination for the delivery stream.

Returns:



343
344
345
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 343

def elasticsearch_destination_configuration()
  jsii_get_property("elasticsearchDestinationConfiguration")
end

#elasticsearch_destination_configuration=(value) ⇒ Object 



347
348
349
350
351
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 347

def elasticsearch_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::ElasticsearchDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRWxhc3RpY3NlYXJjaERlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "elasticsearchDestinationConfiguration") unless value.nil?
  jsii_set_property("elasticsearchDestinationConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



199
200
201
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 199

def env()
  jsii_get_property("env")
end

#extended_s3_destination_configuration ⇒ AWSCDK::IResolvable, ...

An Amazon S3 destination for the delivery stream.

Returns:



356
357
358
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 356

def extended_s3_destination_configuration()
  jsii_get_property("extendedS3DestinationConfiguration")
end

#extended_s3_destination_configuration=(value) ⇒ Object 



360
361
362
363
364
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 360

def extended_s3_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::ExtendedS3DestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRXh0ZW5kZWRTM0Rlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "extendedS3DestinationConfiguration") unless value.nil?
  jsii_set_property("extendedS3DestinationConfiguration", value)
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.

Parameters:

Returns:



688
689
690
691
692
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 688

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



699
700
701
702
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 699

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#http_endpoint_destination_configuration ⇒ AWSCDK::IResolvable, ...

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

Returns:



369
370
371
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 369

def http_endpoint_destination_configuration()
  jsii_get_property("httpEndpointDestinationConfiguration")
end

#http_endpoint_destination_configuration=(value) ⇒ Object 



373
374
375
376
377
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 373

def http_endpoint_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::HttpEndpointDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uSHR0cEVuZHBvaW50RGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "httpEndpointDestinationConfiguration") unless value.nil?
  jsii_set_property("httpEndpointDestinationConfiguration", value)
end

#iceberg_destination_configuration ⇒ AWSCDK::IResolvable, ...

Specifies the destination configure settings for Apache Iceberg Table.

Returns:



382
383
384
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 382

def iceberg_destination_configuration()
  jsii_get_property("icebergDestinationConfiguration")
end

#iceberg_destination_configuration=(value) ⇒ Object 



386
387
388
389
390
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 386

def iceberg_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::IcebergDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uSWNlYmVyZ0Rlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "icebergDestinationConfiguration") unless value.nil?
  jsii_set_property("icebergDestinationConfiguration", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



769
770
771
772
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 769

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kinesis_stream_source_configuration ⇒ AWSCDK::IResolvable, ...

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

Returns:



395
396
397
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 395

def kinesis_stream_source_configuration()
  jsii_get_property("kinesisStreamSourceConfiguration")
end

#kinesis_stream_source_configuration=(value) ⇒ Object 



399
400
401
402
403
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 399

def kinesis_stream_source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::KinesisStreamSourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uS2luZXNpc1N0cmVhbVNvdXJjZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "kinesisStreamSourceConfiguration") unless value.nil?
  jsii_set_property("kinesisStreamSourceConfiguration", value)
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).

Returns:

  • (String) 


151
152
153
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 151

def logical_id()
  jsii_get_property("logicalId")
end

#msk_source_configuration ⇒ AWSCDK::IResolvable, ...

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Returns:



408
409
410
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 408

def msk_source_configuration()
  jsii_get_property("mskSourceConfiguration")
end

#msk_source_configuration=(value) ⇒ Object 



412
413
414
415
416
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 412

def msk_source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::MSKSourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uTVNLU291cmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "mskSourceConfiguration") unless value.nil?
  jsii_set_property("mskSourceConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


134
135
136
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 134

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.

Returns:



710
711
712
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 710

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.

Returns:



717
718
719
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 717

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.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



510
511
512
513
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 510

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

#redshift_destination_configuration ⇒ AWSCDK::IResolvable, ...

An Amazon Redshift destination for the delivery stream.

Returns:



421
422
423
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 421

def redshift_destination_configuration()
  jsii_get_property("redshiftDestinationConfiguration")
end

#redshift_destination_configuration=(value) ⇒ Object 



425
426
427
428
429
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 425

def redshift_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::RedshiftDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUmVkc2hpZnREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "redshiftDestinationConfiguration") unless value.nil?
  jsii_set_property("redshiftDestinationConfiguration", value)
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 }).

Returns:

  • (String) 


170
171
172
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 170

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.

Parameters:



728
729
730
731
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 728

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}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


735
736
737
738
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 735

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.

Parameters:



745
746
747
748
749
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 745

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

#s3_destination_configuration ⇒ AWSCDK::IResolvable, ...

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Returns:



434
435
436
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 434

def s3_destination_configuration()
  jsii_get_property("s3DestinationConfiguration")
end

#s3_destination_configuration=(value) ⇒ Object 



438
439
440
441
442
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 438

def s3_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::S3DestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUzNEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "s3DestinationConfiguration") unless value.nil?
  jsii_set_property("s3DestinationConfiguration", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



754
755
756
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 754

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#snowflake_destination_configuration ⇒ AWSCDK::IResolvable, ...

Configure Snowflake destination.

Returns:



447
448
449
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 447

def snowflake_destination_configuration()
  jsii_get_property("snowflakeDestinationConfiguration")
end

#snowflake_destination_configuration=(value) ⇒ Object 



451
452
453
454
455
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 451

def snowflake_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SnowflakeDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU25vd2ZsYWtlRGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "snowflakeDestinationConfiguration") unless value.nil?
  jsii_set_property("snowflakeDestinationConfiguration", value)
end

#splunk_destination_configuration ⇒ AWSCDK::IResolvable, ...

The configuration of a destination in Splunk for the delivery stream.

Returns:



460
461
462
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 460

def splunk_destination_configuration()
  jsii_get_property("splunkDestinationConfiguration")
end

#splunk_destination_configuration=(value) ⇒ Object 



464
465
466
467
468
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 464

def splunk_destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SplunkDestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU3BsdW5rRGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "splunkDestinationConfiguration") unless value.nil?
  jsii_set_property("splunkDestinationConfiguration", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



160
161
162
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 160

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



245
246
247
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 245

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A set of tags to assign to the Firehose stream.

Returns:



473
474
475
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 473

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



477
478
479
480
481
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 477

def tags_raw=(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.

Returns:

  • (String) —

    a string representation of this resource



486
487
488
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 486

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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.

Returns:

  • (Hash{String => Object}) 


207
208
209
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 207

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.

Returns:

  • (Hash{String => Object}) 


217
218
219
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 217

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


760
761
762
763
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 760

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


499
500
501
502
503
504
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 499

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