InitSource

class aws_cdk.aws_ec2.InitSource(target_directory, service_handles=None)

Bases: InitElement

Extract an archive into a directory.

ExampleMetadata:

infused

Example:

# my_bucket: s3.Bucket


handle = ec2.InitServiceRestartHandle()

ec2.CloudFormationInit.from_elements(
    ec2.InitFile.from_string("/etc/nginx/nginx.conf", "...", service_restart_handles=[handle]),
    ec2.InitSource.from_s3_object("/var/www/html", my_bucket, "html.zip", service_restart_handles=[handle]),
    ec2.InitService.enable("nginx",
        service_restart_handle=handle
    ))
Parameters:

Attributes

element_type

Returns the init element type for this element.

Static Methods

classmethod from_asset(target_directory, path, *, service_restart_handles=None, deploy_time=None, display_name=None, readers=None, source_kms_key=None, asset_hash=None, asset_hash_type=None, bundling=None, exclude=None, follow_symlinks=None, ignore_mode=None)

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

Parameters:

  • target_directory (str)

  • path (str)

  • service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service

  • deploy_time (Optional[bool]) – 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. Default: false

  • display_name (Optional[str]) – 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. Default: - Stack-relative construct path

  • readers (Optional[Sequence[IGrantable]]) – 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. Default: - No principals that can read file asset.

  • source_kms_key (Optional[IKey]) – The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.

  • asset_hash (Optional[str]) – Specify a custom hash for this asset. If assetHashType 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. Default: - based on assetHashType

  • asset_hash_type (Optional[AssetHashType]) – Specifies the type of hash to calculate for this asset. If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM. Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

  • bundling (Union[BundlingOptions, Dict[str, Any], None]) – 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. 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

  • exclude (Optional[Sequence[str]]) – File paths matching the patterns will be excluded. See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property. Default: - nothing is excluded

  • follow_symlinks (Optional[SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER

  • ignore_mode (Optional[IgnoreMode]) – The ignore behavior to use for exclude patterns. Default: IgnoreMode.GLOB

Return type:

InitSource

classmethod from_existing_asset(target_directory, asset, *, service_restart_handles=None)

Extract a directory from an existing directory asset.

Parameters:

  • target_directory (str)

  • asset (Asset)

  • service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service

Return type:

InitSource

classmethod from_git_hub(target_directory, owner, repo, ref_spec=None, *, service_restart_handles=None)

Extract a GitHub branch into a given directory.

Parameters:

  • target_directory (str)

  • owner (str)

  • repo (str)

  • ref_spec (Optional[str])

  • service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service

Return type:

InitSource

classmethod from_s3_object(target_directory, bucket, key, *, service_restart_handles=None)

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

Parameters:

  • target_directory (str)

  • bucket (IBucket)

  • key (str)

  • service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service

Return type:

InitSource

classmethod from_url(target_directory, url, *, service_restart_handles=None)

Retrieve a URL and extract it into the given directory.

Parameters:

  • target_directory (str)

  • url (str)

  • service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given services after this archive has been extracted. Default: - Do not restart any service

Return type:

InitSource