software.amazon.awscdk.services.ec2

Class InitFile

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.InitElement

software.amazon.awscdk.services.ec2.InitFile

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.641Z")
public abstract class InitFile
extends InitElement

Create files on the EC2 instance.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .init(CloudFormationInit.fromElements(InitFile.fromString("/etc/my_instance", "This got written during instance startup")))
         .signals(Signals.waitForAll(SignalsOptions.builder()
                 .timeout(Duration.minutes(10))
                 .build()))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InitFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	InitFile(software.amazon.jsii.JsiiObjectRef objRef)
protected	InitFile(java.lang.String fileName, InitFileOptions options)

Method Summary

Modifier and Type	Method and Description
static InitFile	fromAsset(java.lang.String targetFileName, java.lang.String path) Create an asset from the given file.
static InitFile	fromAsset(java.lang.String targetFileName, java.lang.String path, InitFileAssetOptions options) Create an asset from the given file.
static InitFile	fromExistingAsset(java.lang.String targetFileName, Asset asset) Use a file from an asset at instance startup time.
static InitFile	fromExistingAsset(java.lang.String targetFileName, Asset asset, InitFileOptions options) Use a file from an asset at instance startup time.
static InitFile	fromFileInline(java.lang.String targetFileName, java.lang.String sourceFileName) Read a file from disk and use its contents.
static InitFile	fromFileInline(java.lang.String targetFileName, java.lang.String sourceFileName, InitFileOptions options) Read a file from disk and use its contents.
static InitFile	fromObject(java.lang.String fileName, java.util.Map<java.lang.String,? extends java.lang.Object> obj) Use a JSON-compatible object as the file content, write it to a JSON file.
static InitFile	fromObject(java.lang.String fileName, java.util.Map<java.lang.String,? extends java.lang.Object> obj, InitFileOptions options) Use a JSON-compatible object as the file content, write it to a JSON file.
static InitFile	fromS3Object(java.lang.String fileName, IBucket bucket, java.lang.String key) Download a file from an S3 bucket at instance startup time.
static InitFile	fromS3Object(java.lang.String fileName, IBucket bucket, java.lang.String key, InitFileOptions options) Download a file from an S3 bucket at instance startup time.
static InitFile	fromString(java.lang.String fileName, java.lang.String content) Use a literal string as the file content.
static InitFile	fromString(java.lang.String fileName, java.lang.String content, InitFileOptions options) Use a literal string as the file content.
static InitFile	fromUrl(java.lang.String fileName, java.lang.String url) Download from a URL at instance startup time.
static InitFile	fromUrl(java.lang.String fileName, java.lang.String url, InitFileOptions options) Download from a URL at instance startup time.
java.lang.String	getElementType() Returns the init element type for this element.
static InitFile	symlink(java.lang.String fileName, java.lang.String target) Write a symlink with the given symlink target.
static InitFile	symlink(java.lang.String fileName, java.lang.String target, InitFileOptions options) Write a symlink with the given symlink target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InitFile

protected InitFile(software.amazon.jsii.JsiiObjectRef objRef)

InitFile

protected InitFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

InitFile

protected InitFile(java.lang.String fileName,
                   InitFileOptions options)

Parameters:

fileName - This parameter is required.

options - This parameter is required.

Method Detail

fromAsset

public static InitFile fromAsset(java.lang.String targetFileName,
                                 java.lang.String path,
                                 InitFileAssetOptions options)

Create an asset from the given file.

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

Parameters:

targetFileName - This parameter is required.

path - This parameter is required.

options -

fromAsset

public static InitFile fromAsset(java.lang.String targetFileName,
                                 java.lang.String path)

Create an asset from the given file.

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

Parameters:

targetFileName - This parameter is required.

path - This parameter is required.

fromExistingAsset

public static InitFile fromExistingAsset(java.lang.String targetFileName,
                                         Asset asset,
                                         InitFileOptions options)

Use a file from an asset at instance startup time.

Parameters:

targetFileName - This parameter is required.

asset - This parameter is required.

options -

fromExistingAsset

public static InitFile fromExistingAsset(java.lang.String targetFileName,
                                         Asset asset)

Use a file from an asset at instance startup time.

Parameters:

targetFileName - This parameter is required.

asset - This parameter is required.

fromFileInline

public static InitFile fromFileInline(java.lang.String targetFileName,
                                      java.lang.String sourceFileName,
                                      InitFileOptions options)

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:

targetFileName - This parameter is required.

sourceFileName - This parameter is required.

options -

fromFileInline

public static InitFile fromFileInline(java.lang.String targetFileName,
                                      java.lang.String sourceFileName)

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:

targetFileName - This parameter is required.

sourceFileName - This parameter is required.

fromObject

public static InitFile fromObject(java.lang.String fileName,
                                  java.util.Map<java.lang.String,? extends java.lang.Object> obj,
                                  InitFileOptions options)

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

May contain tokens.

Parameters:

fileName - This parameter is required.

obj - This parameter is required.

options -

fromObject

public static InitFile fromObject(java.lang.String fileName,
                                  java.util.Map<java.lang.String,? extends java.lang.Object> obj)

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

May contain tokens.

Parameters:

fileName - This parameter is required.

obj - This parameter is required.

fromS3Object

public static InitFile fromS3Object(java.lang.String fileName,
                                    IBucket bucket,
                                    java.lang.String key,
                                    InitFileOptions options)

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

Parameters:

fileName - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

options -

fromS3Object

public static InitFile fromS3Object(java.lang.String fileName,
                                    IBucket bucket,
                                    java.lang.String key)

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

Parameters:

fileName - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

fromString

public static InitFile fromString(java.lang.String fileName,
                                  java.lang.String content,
                                  InitFileOptions options)

Use a literal string as the file content.

Parameters:

fileName - This parameter is required.

content - This parameter is required.

options -

fromString

public static InitFile fromString(java.lang.String fileName,
                                  java.lang.String content)

Use a literal string as the file content.

Parameters:

fileName - This parameter is required.

content - This parameter is required.

fromUrl

public static InitFile fromUrl(java.lang.String fileName,
                               java.lang.String url,
                               InitFileOptions options)

Download from a URL at instance startup time.

Parameters:

fileName - This parameter is required.

url - This parameter is required.

options -

fromUrl

public static InitFile fromUrl(java.lang.String fileName,
                               java.lang.String url)

Download from a URL at instance startup time.

Parameters:

fileName - This parameter is required.

url - This parameter is required.

symlink

public static InitFile symlink(java.lang.String fileName,
                               java.lang.String target,
                               InitFileOptions options)

Write a symlink with the given symlink target.

Parameters:

fileName - This parameter is required.

target - This parameter is required.

options -

symlink

public static InitFile symlink(java.lang.String fileName,
                               java.lang.String target)

Write a symlink with the given symlink target.

Parameters:

fileName - This parameter is required.

target - This parameter is required.

getElementType

public java.lang.String getElementType()

Returns the init element type for this element.

Specified by:

getElementType in class InitElement