Class: AWSCDK::KinesisFirehose::SchemaConfiguration

Inherits:

Jsii::Object

• Object
• Jsii::Object
• AWSCDK::KinesisFirehose::SchemaConfiguration

Defined in:

kinesis_firehose/schema_configuration.rb

Overview

Represents a schema configuration for Firehose S3 data record format conversion.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html#cfn-kinesisfirehose-deliverystream-dataformatconversionconfiguration-schemaconfiguration

Class Method Summary

• .from_cfn_table(table, props = nil) ⇒ AWSCDK::KinesisFirehose::SchemaConfiguration

  Obtain schema configuration for data record format conversion from an aws_glue.CfnTable.

• .jsii_overridable_methods ⇒ Object

Instance Method Summary

• #bind(scope, options) ⇒ AWSCDK::KinesisFirehose::CfnDeliveryStream::SchemaConfigurationProperty

  Binds this Schema to the Destination, adding the necessary permissions to the Destination role.

• #initialize(*args) ⇒ SchemaConfiguration constructor

  A new instance of SchemaConfiguration.

Constructor Details

#initialize(*args) ⇒ SchemaConfiguration

Returns a new instance of SchemaConfiguration.

Raises:

• (NoMethodError)

# File 'kinesis_firehose/schema_configuration.rb', line 10

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_kinesisfirehose.SchemaConfiguration does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_cfn_table(table, props = nil) ⇒ AWSCDK::KinesisFirehose::SchemaConfiguration

Obtain schema configuration for data record format conversion from an aws_glue.CfnTable.

Parameters:

• table (AWSCDK::Glue::CfnTable)
• props (AWSCDK::KinesisFirehose::SchemaConfigurationFromCfnTableProps, nil) (defaults to: nil)

Returns:

• (AWSCDK::KinesisFirehose::SchemaConfiguration)

# File 'kinesis_firehose/schema_configuration.rb', line 25

def self.from_cfn_table(table, props = nil)
  Jsii::Type.check_type(table, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2x1ZS5DZm5UYWJsZSJ9")), "table")
  props = props.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::SchemaConfigurationFromCfnTableProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLlNjaGVtYUNvbmZpZ3VyYXRpb25Gcm9tQ2ZuVGFibGVQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kinesisfirehose.SchemaConfiguration", "fromCfnTable", [table, props])
end

.jsii_overridable_methods ⇒ Object

# File 'kinesis_firehose/schema_configuration.rb', line 14

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind(scope, options) ⇒ AWSCDK::KinesisFirehose::CfnDeliveryStream::SchemaConfigurationProperty

Binds this Schema to the Destination, adding the necessary permissions to the Destination role.

Parameters:

• scope (Constructs::Construct)
• options (AWSCDK::KinesisFirehose::SchemaConfigurationBindOptions)

Returns:

• (AWSCDK::KinesisFirehose::CfnDeliveryStream::SchemaConfigurationProperty)

# File 'kinesis_firehose/schema_configuration.rb', line 37

def bind(scope, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  options = options.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::SchemaConfigurationBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLlNjaGVtYUNvbmZpZ3VyYXRpb25CaW5kT3B0aW9ucyJ9")), "options")
  jsii_call_method("bind", [scope, options])
end