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


ec2.Instance(self, "Instance",
    vpc=vpc,
    instance_type=instance_type,
    machine_image=ec2.MachineImage.latest_amazon_linux2023(),

    init=ec2.CloudFormationInit.from_elements(
        # Create a simple config file that runs a Python web server
        ec2.InitService.systemd_config_file("simpleserver",
            command="/usr/bin/python3 -m http.server 8080",
            cwd="/var/www/html"
        ),
        # Start the server using SystemD
        ec2.InitService.enable("simpleserver",
            service_manager=ec2.ServiceManager.SYSTEMD
        ),
        # Drop an example file to show the web server working
        ec2.InitFile.from_string("/var/www/html/index.html", "Hello! It's working!"))
)

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, 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 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
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:

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