Class: AWSCDK::MediaTailor::CfnSourceLocation::SecretsManagerAccessTokenConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_tailor/cfn_source_location.rb

Overview

AWS Secrets Manager access token configuration parameters.

For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication .

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(header_name: nil, secret_arn: nil, secret_string_key: nil) ⇒ SecretsManagerAccessTokenConfigurationProperty

Returns a new instance of SecretsManagerAccessTokenConfigurationProperty.

Parameters:

  • header_name (String, nil) (defaults to: nil)

    The name of the HTTP header used to supply the access token in requests to the source location.

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

    The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

  • secret_string_key (String, nil) (defaults to: nil)

    The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.



716
717
718
719
720
721
722
723
# File 'media_tailor/cfn_source_location.rb', line 716

def initialize(header_name: nil, secret_arn: nil, secret_string_key: nil)
  @header_name = header_name
  Jsii::Type.check_type(@header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName") unless @header_name.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
  @secret_string_key = secret_string_key
  Jsii::Type.check_type(@secret_string_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretStringKey") unless @secret_string_key.nil?
end

Instance Attribute Details

#header_nameString? (readonly)

The name of the HTTP header used to supply the access token in requests to the source location.



729
730
731
# File 'media_tailor/cfn_source_location.rb', line 729

def header_name
  @header_name
end

#secret_arnString? (readonly)

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.



734
735
736
# File 'media_tailor/cfn_source_location.rb', line 734

def secret_arn
  @secret_arn
end

#secret_string_keyString? (readonly)

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.



739
740
741
# File 'media_tailor/cfn_source_location.rb', line 739

def secret_string_key
  @secret_string_key
end

Class Method Details

.jsii_propertiesObject



741
742
743
744
745
746
747
# File 'media_tailor/cfn_source_location.rb', line 741

def self.jsii_properties
  {
    :header_name => "headerName",
    :secret_arn => "secretArn",
    :secret_string_key => "secretStringKey",
  }
end

Instance Method Details

#to_jsiiObject



749
750
751
752
753
754
755
756
757
# File 'media_tailor/cfn_source_location.rb', line 749

def to_jsii
  result = {}
  result.merge!({
    "headerName" => @header_name,
    "secretArn" => @secret_arn,
    "secretStringKey" => @secret_string_key,
  })
  result.compact
end