Class: AWSCDK::S3Assets::AssetOptions

Inherits:
AssetOptions
  • Object
show all
Defined in:
s3_assets/asset_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(asset_hash: nil, asset_hash_type: nil, bundling: nil, exclude: nil, follow_symlinks: nil, ignore_mode: nil, deploy_time: nil, display_name: nil, readers: nil, source_kms_key: nil) ⇒ AssetOptions

Returns a new instance of AssetOptions.

Parameters:

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

    Specify a custom hash for this asset.

  • asset_hash_type (AWSCDK::AssetHashType, nil) (defaults to: nil) —

    Specifies the type of hash to calculate for this asset.

  • bundling (AWSCDK::BundlingOptions, nil) (defaults to: nil) —

    Bundle the asset by executing a command in a Docker container or a custom bundling provider.

  • exclude (Array<String>, nil) (defaults to: nil) —

    File paths matching the patterns will be excluded.

  • follow_symlinks (AWSCDK::SymlinkFollowMode, nil) (defaults to: nil) —

    A strategy for how to handle symlinks.

  • ignore_mode (AWSCDK::IgnoreMode, nil) (defaults to: nil) —

    The ignore behavior to use for exclude patterns.

  • deploy_time (Boolean, nil) (defaults to: nil) —

    Whether or not the asset needs to exist beyond deployment time;

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

    A display name for this asset.

  • readers (Array<AWSCDK::IAM::IGrantable>, nil) (defaults to: nil) —

    A list of principals that should be able to read this asset from S3.

  • source_kms_key (AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    The ARN of the KMS key used to encrypt the handler code.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 's3_assets/asset_options.rb', line 17

def initialize(asset_hash: nil, asset_hash_type: nil, bundling: nil, exclude: nil, follow_symlinks: nil, ignore_mode: nil, deploy_time: nil, display_name: nil, readers: nil, source_kms_key: nil)
  @asset_hash = asset_hash
  Jsii::Type.check_type(@asset_hash, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assetHash") unless @asset_hash.nil?
  @asset_hash_type = asset_hash_type
  Jsii::Type.check_type(@asset_hash_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bc3NldEhhc2hUeXBlIn0=")), "assetHashType") unless @asset_hash_type.nil?
  @bundling = bundling.is_a?(Hash) ? ::AWSCDK::BundlingOptions.new(**bundling.transform_keys(&:to_sym)) : bundling
  Jsii::Type.check_type(@bundling, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5CdW5kbGluZ09wdGlvbnMifQ==")), "bundling") unless @bundling.nil?
  @exclude = exclude
  Jsii::Type.check_type(@exclude, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "exclude") unless @exclude.nil?
  @follow_symlinks = follow_symlinks
  Jsii::Type.check_type(@follow_symlinks, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TeW1saW5rRm9sbG93TW9kZSJ9")), "followSymlinks") unless @follow_symlinks.nil?
  @ignore_mode = ignore_mode
  Jsii::Type.check_type(@ignore_mode, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5JZ25vcmVNb2RlIn0=")), "ignoreMode") unless @ignore_mode.nil?
  @deploy_time = deploy_time
  Jsii::Type.check_type(@deploy_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "deployTime") unless @deploy_time.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @readers = readers
  Jsii::Type.check_type(@readers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pYW0uSUdyYW50YWJsZSJ9LCJraW5kIjoiYXJyYXkifX0=")), "readers") unless @readers.nil?
  @source_kms_key = source_kms_key
  Jsii::Type.check_type(@source_kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9")), "sourceKMSKey") unless @source_kms_key.nil?
end

Instance Attribute Details

#asset_hash ⇒ String? (readonly)

Note:

Default: - based on assetHashType

Specify a custom hash for this asset.

If asset_hash_type is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

Returns:

  • (String, nil) 


55
56
57
 
# File 's3_assets/asset_options.rb', line 55

def asset_hash
  @asset_hash
end

#asset_hash_type ⇒ AWSCDK::AssetHashType? (readonly)

Note:

Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

Specifies the type of hash to calculate for this asset.

If asset_hash is configured, this option must be undefined or AssetHashType.CUSTOM.

Returns:



63
64
65
 
# File 's3_assets/asset_options.rb', line 63

def asset_hash_type
  @asset_hash_type
end

#bundling ⇒ AWSCDK::BundlingOptions? (readonly)

Note:

Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise

Bundle the asset by executing a command in a Docker container or a custom bundling provider.

The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset.

Returns:



73
74
75
 
# File 's3_assets/asset_options.rb', line 73

def bundling
  @bundling
end

#deploy_time ⇒ Boolean? (readonly)

Note:

Default: false

Whether or not the asset needs to exist beyond deployment time;

i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.

For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.

Returns:

  • (Boolean, nil) 


106
107
108
 
# File 's3_assets/asset_options.rb', line 106

def deploy_time
  @deploy_time
end

#display_name ⇒ String? (readonly)

Note:

Default: - Stack-relative construct path

A display name for this asset.

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAsset()), this will look like MyFunction/Code.

We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

Returns:

  • (String, nil) 


126
127
128
 
# File 's3_assets/asset_options.rb', line 126

def display_name
  @display_name
end

#exclude ⇒ Array<String>? (readonly)

Note:

Default: - nothing is excluded

File paths matching the patterns will be excluded.

See ignore_mode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Returns:

  • (Array<String>, nil) 


81
82
83
 
# File 's3_assets/asset_options.rb', line 81

def exclude
  @exclude
end

#follow_symlinks ⇒ AWSCDK::SymlinkFollowMode? (readonly)

Note:

Default: SymlinkFollowMode.NEVER

A strategy for how to handle symlinks.

Returns:



86
87
88
 
# File 's3_assets/asset_options.rb', line 86

def follow_symlinks
  @follow_symlinks
end

#ignore_mode ⇒ AWSCDK::IgnoreMode? (readonly)

Note:

Default: IgnoreMode.GLOB

The ignore behavior to use for exclude patterns.

Returns:



91
92
93
 
# File 's3_assets/asset_options.rb', line 91

def ignore_mode
  @ignore_mode
end

#readers ⇒ Array<AWSCDK::IAM::IGrantable>? (readonly)

Note:

Default: - No principals that can read file asset.

A list of principals that should be able to read this asset from S3.

You can use asset.grantRead(principal) to grant read permissions later.

Returns:



133
134
135
 
# File 's3_assets/asset_options.rb', line 133

def readers
  @readers
end

#source_kms_key ⇒ AWSCDK::Interfaces::AWSKMS::IKeyRef? (readonly)

Note:

Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.

The ARN of the KMS key used to encrypt the handler code.

Returns:



138
139
140
 
# File 's3_assets/asset_options.rb', line 138

def source_kms_key
  @source_kms_key
end

Class Method Details

.jsii_properties ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 's3_assets/asset_options.rb', line 140

def self.jsii_properties
  {
    :asset_hash => "assetHash",
    :asset_hash_type => "assetHashType",
    :bundling => "bundling",
    :exclude => "exclude",
    :follow_symlinks => "followSymlinks",
    :ignore_mode => "ignoreMode",
    :deploy_time => "deployTime",
    :display_name => "displayName",
    :readers => "readers",
    :source_kms_key => "sourceKMSKey",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 's3_assets/asset_options.rb', line 155

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "assetHash" => @asset_hash,
    "assetHashType" => @asset_hash_type,
    "bundling" => @bundling,
    "exclude" => @exclude,
    "followSymlinks" => @follow_symlinks,
    "ignoreMode" => @ignore_mode,
    "deployTime" => @deploy_time,
    "displayName" => @display_name,
    "readers" => @readers,
    "sourceKMSKey" => @source_kms_key,
  })
  result.compact
end