Class: AWSCDK::Batch::Secret

Inherits:
Jsii::Object
  • Object
show all
Defined in:
batch/secret.rb

Overview

A secret environment variable.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Secret

Returns a new instance of Secret.



8
9
10
 
# File 'batch/secret.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_secrets_manager(secret, field = nil) ⇒ AWSCDK::Batch::Secret

Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

  • secret (AWSCDK::SecretsManager::ISecret) —

    the secret stored in AWS Secrets Manager.

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

    the name of the field with the value that you want to set as the environment variable value.

Returns:

  • (AWSCDK::Batch::Secret) 


25
26
27
28
29
 
# File 'batch/secret.rb', line 25

def self.from_secrets_manager(secret, field = nil)
  Jsii::Type.check_type(secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secret")
  Jsii::Type.check_type(field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "field") unless field.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.Secret", "fromSecretsManager", [secret, field])
end

.from_secrets_manager_version(secret, version_info, field = nil) ⇒ AWSCDK::Batch::Secret

Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

  • secret (AWSCDK::SecretsManager::ISecret) —

    the secret stored in AWS Secrets Manager.

  • version_info (AWSCDK::Batch::SecretVersionInfo) —

    the version information to reference the secret.

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

    the name of the field with the value that you want to set as the environment variable value.

Returns:

  • (AWSCDK::Batch::Secret) 


37
38
39
40
41
42
43
 
# File 'batch/secret.rb', line 37

def self.from_secrets_manager_version(secret, version_info, field = nil)
  Jsii::Type.check_type(secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secret")
  version_info = version_info.is_a?(Hash) ? ::AWSCDK::Batch::SecretVersionInfo.new(**version_info.transform_keys(&:to_sym)) : version_info
  Jsii::Type.check_type(version_info, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guU2VjcmV0VmVyc2lvbkluZm8ifQ==")), "versionInfo")
  Jsii::Type.check_type(field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "field") unless field.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.Secret", "fromSecretsManagerVersion", [secret, version_info, field])
end

.from_ssm_parameter(parameter) ⇒ AWSCDK::Batch::Secret

Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.

Parameters:

Returns:

  • (AWSCDK::Batch::Secret) 


49
50
51
52
 
# File 'batch/secret.rb', line 49

def self.from_ssm_parameter(parameter)
  Jsii::Type.check_type(parameter, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLklQYXJhbWV0ZXIifQ==")), "parameter")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.Secret", "fromSsmParameter", [parameter])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
 
# File 'batch/secret.rb', line 12

def self.jsii_overridable_methods
  {
    :arn => { kind: :property, name: "arn", is_optional: false },
    :has_field => { kind: :property, name: "hasField", is_optional: true },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
  }
end

Instance Method Details

#arn ⇒ String

The ARN of the secret.

Returns:

  • (String) 


57
58
59
 
# File 'batch/secret.rb', line 57

def arn()
  jsii_get_property("arn")
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grants reading the secret to a principal [disable-awslint:no-grants].

Parameters:

Returns:



72
73
74
75
 
# File 'batch/secret.rb', line 72

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#has_field ⇒ Boolean?

Whether this secret uses a specific JSON field.

Returns:

  • (Boolean, nil) 


64
65
66
 
# File 'batch/secret.rb', line 64

def has_field()
  jsii_get_property("hasField")
end