Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::SecretsManagerConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/cfn_delivery_stream.rb

Overview

The structure that defines how Firehose accesses the secret.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled:, role_arn: nil, secret_arn: nil) ⇒ SecretsManagerConfigurationProperty

Returns a new instance of SecretsManagerConfigurationProperty.

Parameters:

  • enabled (Boolean, AWSCDK::IResolvable) —

    Specifies whether you want to use the secrets manager feature.

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

    Specifies the role that Firehose assumes when calling the Secrets Manager API operation.

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

    The ARN of the secret that stores your credentials.



4397
4398
4399
4400
4401
4402
4403
4404
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4397

def initialize(enabled:, role_arn: nil, secret_arn: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

Specifies whether you want to use the secrets manager feature.

When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

Returns:

See Also:



4412
4413
4414
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4412

def enabled
  @enabled
end

#role_arn ⇒ String? (readonly)

Specifies the role that Firehose assumes when calling the Secrets Manager API operation.

When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

Returns:

  • (String, nil)

See Also:



4419
4420
4421
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4419

def role_arn
  @role_arn
end

#secret_arn ⇒ String? (readonly)

The ARN of the secret that stores your credentials.

It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True .

Returns:

  • (String, nil)

See Also:



4426
4427
4428
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4426

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object 



4428
4429
4430
4431
4432
4433
4434
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4428

def self.jsii_properties
  {
    :enabled => "enabled",
    :role_arn => "roleArn",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4436
4437
4438
4439
4440
4441
4442
4443
4444
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 4436

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "roleArn" => @role_arn,
    "secretArn" => @secret_arn,
  })
  result.compact
end