software.amazon.awscdk.services.ec2

Class InitSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.InitElement

software.amazon.awscdk.services.ec2.InitSource

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:59.472Z")
public abstract class InitSource
extends InitElement

Extract an archive into a directory.

Example:

 Bucket myBucket;
 InitServiceRestartHandle handle = new InitServiceRestartHandle();
 CloudFormationInit.fromElements(InitFile.fromString("/etc/nginx/nginx.conf", "...", InitFileOptions.builder().serviceRestartHandles(List.of(handle)).build()), InitSource.fromS3Object("/var/www/html", myBucket, "html.zip", InitSourceOptions.builder().serviceRestartHandles(List.of(handle)).build()), InitService.enable("nginx", InitServiceOptions.builder()
         .serviceRestartHandle(handle)
         .build()));
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InitSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	InitSource(software.amazon.jsii.JsiiObjectRef objRef)
protected	InitSource(java.lang.String targetDirectory, java.util.List<InitServiceRestartHandle> serviceHandles)

Method Summary

Modifier and Type	Method and Description
static InitSource	fromAsset(java.lang.String targetDirectory, java.lang.String path) Create an InitSource from an asset created from the given path.
static InitSource	fromAsset(java.lang.String targetDirectory, java.lang.String path, InitSourceAssetOptions options) Create an InitSource from an asset created from the given path.
static InitSource	fromExistingAsset(java.lang.String targetDirectory, Asset asset) Extract a directory from an existing directory asset.
static InitSource	fromExistingAsset(java.lang.String targetDirectory, Asset asset, InitSourceOptions options) Extract a directory from an existing directory asset.
static InitSource	fromGitHub(java.lang.String targetDirectory, java.lang.String owner, java.lang.String repo) Extract a GitHub branch into a given directory.
static InitSource	fromGitHub(java.lang.String targetDirectory, java.lang.String owner, java.lang.String repo, java.lang.String refSpec) Extract a GitHub branch into a given directory.
static InitSource	fromGitHub(java.lang.String targetDirectory, java.lang.String owner, java.lang.String repo, java.lang.String refSpec, InitSourceOptions options) Extract a GitHub branch into a given directory.
static InitSource	fromS3Object(java.lang.String targetDirectory, IBucket bucket, java.lang.String key) Extract an archive stored in an S3 bucket into the given directory.
static InitSource	fromS3Object(java.lang.String targetDirectory, IBucket bucket, java.lang.String key, InitSourceOptions options) Extract an archive stored in an S3 bucket into the given directory.
static InitSource	fromUrl(java.lang.String targetDirectory, java.lang.String url) Retrieve a URL and extract it into the given directory.
static InitSource	fromUrl(java.lang.String targetDirectory, java.lang.String url, InitSourceOptions options) Retrieve a URL and extract it into the given directory.
java.lang.String	getElementType() Returns the init element type for this element.

Methods inherited from class java.lang.Object

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

Constructor Detail

InitSource

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

InitSource

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

InitSource

protected InitSource(java.lang.String targetDirectory,
                     java.util.List<InitServiceRestartHandle> serviceHandles)

Parameters:

targetDirectory - This parameter is required.

serviceHandles -

Method Detail

fromAsset

public static InitSource fromAsset(java.lang.String targetDirectory,
                                   java.lang.String path,
                                   InitSourceAssetOptions options)

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

Parameters:

targetDirectory - This parameter is required.

path - This parameter is required.

options -

fromAsset

public static InitSource fromAsset(java.lang.String targetDirectory,
                                   java.lang.String path)

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

Parameters:

targetDirectory - This parameter is required.

path - This parameter is required.

fromExistingAsset

public static InitSource fromExistingAsset(java.lang.String targetDirectory,
                                           Asset asset,
                                           InitSourceOptions options)

Extract a directory from an existing directory asset.

Parameters:

targetDirectory - This parameter is required.

asset - This parameter is required.

options -

fromExistingAsset

public static InitSource fromExistingAsset(java.lang.String targetDirectory,
                                           Asset asset)

Extract a directory from an existing directory asset.

Parameters:

targetDirectory - This parameter is required.

asset - This parameter is required.

fromGitHub

public static InitSource fromGitHub(java.lang.String targetDirectory,
                                    java.lang.String owner,
                                    java.lang.String repo,
                                    java.lang.String refSpec,
                                    InitSourceOptions options)

Extract a GitHub branch into a given directory.

Parameters:

targetDirectory - This parameter is required.

owner - This parameter is required.

repo - This parameter is required.

refSpec -

options -

fromGitHub

public static InitSource fromGitHub(java.lang.String targetDirectory,
                                    java.lang.String owner,
                                    java.lang.String repo,
                                    java.lang.String refSpec)

Extract a GitHub branch into a given directory.

Parameters:

targetDirectory - This parameter is required.

owner - This parameter is required.

repo - This parameter is required.

refSpec -

fromGitHub

public static InitSource fromGitHub(java.lang.String targetDirectory,
                                    java.lang.String owner,
                                    java.lang.String repo)

Extract a GitHub branch into a given directory.

Parameters:

targetDirectory - This parameter is required.

owner - This parameter is required.

repo - This parameter is required.

fromS3Object

public static InitSource fromS3Object(java.lang.String targetDirectory,
                                      IBucket bucket,
                                      java.lang.String key,
                                      InitSourceOptions options)

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

Parameters:

targetDirectory - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

options -

fromS3Object

public static InitSource fromS3Object(java.lang.String targetDirectory,
                                      IBucket bucket,
                                      java.lang.String key)

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

Parameters:

targetDirectory - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

fromUrl

public static InitSource fromUrl(java.lang.String targetDirectory,
                                 java.lang.String url,
                                 InitSourceOptions options)

Retrieve a URL and extract it into the given directory.

Parameters:

targetDirectory - This parameter is required.

url - This parameter is required.

options -

fromUrl

public static InitSource fromUrl(java.lang.String targetDirectory,
                                 java.lang.String url)

Retrieve a URL and extract it into the given directory.

Parameters:

targetDirectory - This parameter is required.

url - This parameter is required.

getElementType

public java.lang.String getElementType()

Returns the init element type for this element.

Specified by:

getElementType in class InitElement