Class: AWSCDK::ECS::DomainJoinedCredentialSpec

Inherits:
CredentialSpec
  • Object
show all
Defined in:
ecs/domain_joined_credential_spec.rb

Overview

Credential specification (CredSpec) file.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_location) ⇒ DomainJoinedCredentialSpec

Returns a new instance of DomainJoinedCredentialSpec.

Parameters:

  • file_location (String) —

    Location or ARN from where to retrieve the CredSpec file.



9
10
11
12
 
# File 'ecs/domain_joined_credential_spec.rb', line 9

def initialize(file_location)
  Jsii::Type.check_type(file_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileLocation")
  Jsii::Object.instance_method(:initialize).bind(self).call(file_location)
end

Class Method Details

.from_s3_bucket(bucket, key) ⇒ AWSCDK::ECS::DomainJoinedCredentialSpec

Loads the CredSpec from a S3 bucket object.

Parameters:

Returns:

  • (AWSCDK::ECS::DomainJoinedCredentialSpec) —

    CredSpec with it's locations set to the S3 object's ARN.



27
28
29
30
31
 
# File 'ecs/domain_joined_credential_spec.rb', line 27

def self.from_s3_bucket(bucket, key)
  Jsii::Type.check_type(bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket")
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ecs.DomainJoinedCredentialSpec", "fromS3Bucket", [bucket, key])
end

.from_ssm_parameter(parameter) ⇒ AWSCDK::ECS::DomainJoinedCredentialSpec

Loads the CredSpec from a SSM parameter.

Parameters:

Returns:

  • (AWSCDK::ECS::DomainJoinedCredentialSpec) —

    CredSpec with it's locations set to the SSM parameter's ARN.



37
38
39
40
 
# File 'ecs/domain_joined_credential_spec.rb', line 37

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_ecs.DomainJoinedCredentialSpec", "fromSsmParameter", [parameter])
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
19
20
 
# File 'ecs/domain_joined_credential_spec.rb', line 14

def self.jsii_overridable_methods
  {
    :file_location => { kind: :property, name: "fileLocation", is_optional: false },
    :prefix_id => { kind: :property, name: "prefixId", is_optional: false },
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind ⇒ AWSCDK::ECS::CredentialSpecConfig

Called when the container is initialized to allow this object to bind to the stack.

Returns:



59
60
61
 
# File 'ecs/domain_joined_credential_spec.rb', line 59

def bind()
  jsii_call_method("bind", [])
end

#file_location ⇒ String

Location or ARN from where to retrieve the CredSpec file.

Returns:

  • (String) 


45
46
47
 
# File 'ecs/domain_joined_credential_spec.rb', line 45

def file_location()
  jsii_get_property("fileLocation")
end

#prefix_id ⇒ String

Prefix string based on the type of CredSpec.

Returns:

  • (String) 


52
53
54
 
# File 'ecs/domain_joined_credential_spec.rb', line 52

def prefix_id()
  jsii_get_property("prefixId")
end