Class: AWSCDK::MediaConnect::CfnFlowOutput::EncryptionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_connect/cfn_flow_output.rb

Overview

Encryption information.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_arn:, secret_arn:, algorithm: nil, key_type: nil) ⇒ EncryptionProperty

Returns a new instance of EncryptionProperty.

Parameters:

  • role_arn (String) —

    The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).

  • secret_arn (String) —

    The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

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

    The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).

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

    The type of key that is used for the encryption.



891
892
893
894
895
896
897
898
899
900
 
# File 'media_connect/cfn_flow_output.rb', line 891

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

Instance Attribute Details

#algorithm ⇒ String? (readonly)

The type of algorithm that is used for static key encryption (such as aes128, aes192, or aes256).

If you are using SPEKE or SRT-password encryption, this property must be left blank.

Returns:

  • (String, nil)

See Also:



920
921
922
 
# File 'media_connect/cfn_flow_output.rb', line 920

def algorithm
  @algorithm
end

#key_type ⇒ String? (readonly)

Note:

Default: - "static-key"

The type of key that is used for the encryption.

If you don't specify a key_type value, the service uses the default setting ( static-key ). Valid key types are: static-key , speke , and srt-password .

Returns:

  • (String, nil)

See Also:



928
929
930
 
# File 'media_connect/cfn_flow_output.rb', line 928

def key_type
  @key_type
end

#role_arn ⇒ String (readonly)

The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).

Returns:

  • (String)

See Also:



906
907
908
 
# File 'media_connect/cfn_flow_output.rb', line 906

def role_arn
  @role_arn
end

#secret_arn ⇒ String (readonly)

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.

This parameter is required for static key encryption and is not valid for SPEKE encryption.

Returns:

  • (String)

See Also:



913
914
915
 
# File 'media_connect/cfn_flow_output.rb', line 913

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object 



930
931
932
933
934
935
936
937
 
# File 'media_connect/cfn_flow_output.rb', line 930

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

Instance Method Details

#to_jsii ⇒ Object 



939
940
941
942
943
944
945
946
947
948
 
# File 'media_connect/cfn_flow_output.rb', line 939

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