InitFile

class aws_cdk.aws_ec2.InitFile(file_name, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Bases: InitElement

Create files on the EC2 instance.

ExampleMetadata:: infused

Example:

# vpc: ec2.Vpc
# instance_type: ec2.InstanceType
# machine_image: ec2.IMachineImage


autoscaling.AutoScalingGroup(self, "ASG",
    vpc=vpc,
    instance_type=instance_type,
    machine_image=machine_image,

    # ...

    init=ec2.CloudFormationInit.from_elements(
        ec2.InitFile.from_string("/etc/my_instance", "This got written during instance startup")),
    signals=autoscaling.Signals.wait_for_all(
        timeout=Duration.minutes(10)
    )
)

Parameters:

file_name (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Attributes

element_type: Returns the init element type for this element.

Static Methods

classmethod from_asset(target_file_name, path, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None, readers=None, source_hash=None, exclude=None, follow=None, ignore_mode=None, follow_symlinks=None, asset_hash=None, asset_hash_type=None, bundling=None)

Create an asset from the given file.

This is appropriate for files that are too large to embed into the template.

Parameters:

target_file_name (str) –
path (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service
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_hash (Optional[str]) – (deprecated) Custom hash to use when identifying the specific version of the asset. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the source 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 source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated. Default: - automatically calculate source hash based on the contents of the source file or directory.
exclude (Optional[Sequence[str]]) – (deprecated) Glob patterns to exclude from the copy. Default: nothing is excluded
follow (Optional[FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never
ignore_mode (Optional[IgnoreMode]) – (deprecated) The ignore behavior to use for exclude patterns. Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the ‘
follow_symlinks (Optional[SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
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

Return type:

InitFile

classmethod from_existing_asset(target_file_name, asset, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Use a file from an asset at instance startup time.

Parameters:

target_file_name (str) –
asset (Asset) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod from_file_inline(target_file_name, source_file_name, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Read a file from disk and use its contents.

The file will be embedded in the template, so care should be taken to not exceed the template size.

If options.base64encoded is set to true, this will base64-encode the file’s contents.

Parameters:

target_file_name (str) –
source_file_name (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod from_object(file_name, obj, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Use a JSON-compatible object as the file content, write it to a JSON file.

May contain tokens.

Parameters:

file_name (str) –
obj (Mapping[str, Any]) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod from_s3_object(file_name, bucket, key, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Download a file from an S3 bucket at instance startup time.

Parameters:

file_name (str) –
bucket (IBucket) –
key (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod from_string(file_name, content, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Use a literal string as the file content.

Parameters:

file_name (str) –
content (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod from_url(file_name, url, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Download from a URL at instance startup time.

Parameters:

file_name (str) –
url (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile

classmethod symlink(file_name, target, *, base64_encoded=None, group=None, mode=None, owner=None, service_restart_handles=None)

Write a symlink with the given symlink target.

Parameters:

file_name (str) –
target (str) –
base64_encoded (Optional[bool]) – True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content. Default: false
group (Optional[str]) – The name of the owning group for this file. Not supported for Windows systems. Default: ‘root’
mode (Optional[str]) – A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644. Not supported for Windows systems. Default: ‘000644’
owner (Optional[str]) – The name of the owning user for this file. Not supported for Windows systems. Default: ‘root’
service_restart_handles (Optional[Sequence[InitServiceRestartHandle]]) – Restart the given service after this file has been written. Default: - Do not restart any service

Return type:

InitFile