Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::HttpEndpointConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::KinesisFirehose::CfnDeliveryStream::HttpEndpointConfigurationProperty

Defined in:

kinesis_firehose/cfn_delivery_stream.rb

Overview

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html

Instance Attribute Summary

• #access_key ⇒ String^? readonly

  The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

• #name ⇒ String^? readonly

  The name of the HTTP endpoint selected as the destination.

• #url ⇒ String readonly

  The URL of the HTTP endpoint selected as the destination.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(url:, access_key: nil, name: nil) ⇒ HttpEndpointConfigurationProperty constructor

  A new instance of HttpEndpointConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(url:, access_key: nil, name: nil) ⇒ HttpEndpointConfigurationProperty

Returns a new instance of HttpEndpointConfigurationProperty.

Parameters:

• url (String) —

  The URL of the HTTP endpoint selected as the destination.

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

  The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

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

  The name of the HTTP endpoint selected as the destination.

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2814

def initialize(url:, access_key: nil, name: nil)
  @url = url
  Jsii::Type.check_type(@url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url")
  @access_key = access_key
  Jsii::Type.check_type(@access_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessKey") unless @access_key.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#access_key ⇒ String^? (readonly)

The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-accesskey

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2832

def access_key
  @access_key
end

#name ⇒ String^? (readonly)

The name of the HTTP endpoint selected as the destination.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-name

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2837

def name
  @name
end

#url ⇒ String (readonly)

The URL of the HTTP endpoint selected as the destination.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointconfiguration-url

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2827

def url
  @url
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2839

def self.jsii_properties
  {
    :url => "url",
    :access_key => "accessKey",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 2847

def to_jsii
  result = {}
  result.merge!({
    "url" => @url,
    "accessKey" => @access_key,
    "name" => @name,
  })
  result.compact
end