Class: AWSCDK::EC2::InitSource

Inherits:
InitElement
  • Object
show all
Defined in:
ec2/init_source.rb

Overview

Extract an archive into a directory.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_directory, service_handles = nil) ⇒ InitSource

Returns a new instance of InitSource.

Parameters:



10
11
12
13
14
# File 'ec2/init_source.rb', line 10

def initialize(target_directory, service_handles = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(service_handles, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuSW5pdFNlcnZpY2VSZXN0YXJ0SGFuZGxlIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "serviceHandles") unless service_handles.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(target_directory, service_handles)
end

Class Method Details

.from_asset(target_directory, path, options = nil) ⇒ AWSCDK::EC2::InitSource

Create an InitSource from an asset created from the given path.

Parameters:

Returns:

  • (AWSCDK::EC2::InitSource)


28
29
30
31
32
33
34
# File 'ec2/init_source.rb', line 28

def self.from_asset(target_directory, path, options = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::InitSourceAssetOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluaXRTb3VyY2VBc3NldE9wdGlvbnMifQ==")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InitSource", "fromAsset", [target_directory, path, options])
end

.from_existing_asset(target_directory, asset, options = nil) ⇒ AWSCDK::EC2::InitSource

Extract a directory from an existing directory asset.

Parameters:

Returns:

  • (AWSCDK::EC2::InitSource)


42
43
44
45
46
47
48
# File 'ec2/init_source.rb', line 42

def self.from_existing_asset(target_directory, asset, options = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(asset, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczNfYXNzZXRzLkFzc2V0In0=")), "asset")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::InitSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluaXRTb3VyY2VPcHRpb25zIn0=")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InitSource", "fromExistingAsset", [target_directory, asset, options])
end

.from_git_hub(target_directory, owner, repo, ref_spec = nil, options = nil) ⇒ AWSCDK::EC2::InitSource

Extract a GitHub branch into a given directory.

Parameters:

  • target_directory (String)
  • owner (String)
  • repo (String)
  • ref_spec (String, nil) (defaults to: nil)
  • options (AWSCDK::EC2::InitSourceOptions, nil) (defaults to: nil)

Returns:

  • (AWSCDK::EC2::InitSource)


58
59
60
61
62
63
64
65
66
# File 'ec2/init_source.rb', line 58

def self.from_git_hub(target_directory, owner, repo, ref_spec = nil, options = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner")
  Jsii::Type.check_type(repo, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repo")
  Jsii::Type.check_type(ref_spec, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "refSpec") unless ref_spec.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::InitSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluaXRTb3VyY2VPcHRpb25zIn0=")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InitSource", "fromGitHub", [target_directory, owner, repo, ref_spec, options])
end

.from_s3_object(target_directory, bucket, key, options = nil) ⇒ AWSCDK::EC2::InitSource

Extract an archive stored in an S3 bucket into the given directory.

Parameters:

Returns:

  • (AWSCDK::EC2::InitSource)


75
76
77
78
79
80
81
82
# File 'ec2/init_source.rb', line 75

def self.from_s3_object(target_directory, bucket, key, options = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket")
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::InitSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluaXRTb3VyY2VPcHRpb25zIn0=")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InitSource", "fromS3Object", [target_directory, bucket, key, options])
end

.from_url(target_directory, url, options = nil) ⇒ AWSCDK::EC2::InitSource

Retrieve a URL and extract it into the given directory.

Parameters:

Returns:

  • (AWSCDK::EC2::InitSource)


90
91
92
93
94
95
96
# File 'ec2/init_source.rb', line 90

def self.from_url(target_directory, url, options = nil)
  Jsii::Type.check_type(target_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetDirectory")
  Jsii::Type.check_type(url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::InitSourceOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkluaXRTb3VyY2VPcHRpb25zIn0=")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InitSource", "fromUrl", [target_directory, url, options])
end

.jsii_overridable_methodsObject



16
17
18
19
20
# File 'ec2/init_source.rb', line 16

def self.jsii_overridable_methods
  {
    :element_type => { kind: :property, name: "elementType", is_optional: false },
  }
end

Instance Method Details

#element_typeString

Returns the init element type for this element.

Returns:

  • (String)


101
102
103
# File 'ec2/init_source.rb', line 101

def element_type()
  jsii_get_property("elementType")
end