InitSource (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.ec2.InitElement
  - - software.amazon.awscdk.services.ec2.InitSource

All Implemented Interfaces:: software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.641Z")
 @Stability(value=Experimental)
public abstract class InitSource
extends InitElement

(experimental) Extract an archive into a directory.

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

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

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Constructor Detail

InitSource

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

InitSource

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

InitSource

@Stability(value=Experimental)
protected InitSource(@NotNull
                                                    String targetDirectory,
                                                    @Nullable
                                                    List<InitServiceRestartHandle> serviceHandles)

Parameters:: targetDirectory - This parameter is required.; serviceHandles -

InitSource

@Stability(value=Experimental)
protected InitSource(@NotNull
                                                    String targetDirectory)

Parameters:: targetDirectory - This parameter is required.

Method Detail

fromAsset

@Stability(value=Experimental)
 @NotNull
public static InitSource fromAsset(@NotNull
                                                                            String targetDirectory,
                                                                            @NotNull
                                                                            String path,
                                                                            @Nullable
                                                                            InitSourceAssetOptions options)

(experimental) Create an InitSource from an asset created from the given path.

Parameters:: targetDirectory - This parameter is required.; path - This parameter is required.; options -

fromAsset

@Stability(value=Experimental)
 @NotNull
public static InitSource fromAsset(@NotNull
                                                                            String targetDirectory,
                                                                            @NotNull
                                                                            String path)

(experimental) Create an InitSource from an asset created from the given path.

Parameters:: targetDirectory - This parameter is required.; path - This parameter is required.

fromExistingAsset

@Stability(value=Experimental)
 @NotNull
public static InitSource fromExistingAsset(@NotNull
                                                                                    String targetDirectory,
                                                                                    @NotNull
                                                                                    Asset asset,
                                                                                    @Nullable
                                                                                    InitSourceOptions options)

(experimental) Extract a directory from an existing directory asset.

Parameters:: targetDirectory - This parameter is required.; asset - This parameter is required.; options -

fromExistingAsset

@Stability(value=Experimental)
 @NotNull
public static InitSource fromExistingAsset(@NotNull
                                                                                    String targetDirectory,
                                                                                    @NotNull
                                                                                    Asset asset)

(experimental) Extract a directory from an existing directory asset.

Parameters:: targetDirectory - This parameter is required.; asset - This parameter is required.

fromGitHub

@Stability(value=Experimental)
 @NotNull
public static InitSource fromGitHub(@NotNull
                                                                             String targetDirectory,
                                                                             @NotNull
                                                                             String owner,
                                                                             @NotNull
                                                                             String repo,
                                                                             @Nullable
                                                                             String refSpec,
                                                                             @Nullable
                                                                             InitSourceOptions options)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public static InitSource fromGitHub(@NotNull
                                                                             String targetDirectory,
                                                                             @NotNull
                                                                             String owner,
                                                                             @NotNull
                                                                             String repo,
                                                                             @Nullable
                                                                             String refSpec)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public static InitSource fromGitHub(@NotNull
                                                                             String targetDirectory,
                                                                             @NotNull
                                                                             String owner,
                                                                             @NotNull
                                                                             String repo)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public static InitSource fromS3Object(@NotNull
                                                                               String targetDirectory,
                                                                               @NotNull
                                                                               IBucket bucket,
                                                                               @NotNull
                                                                               String key,
                                                                               @Nullable
                                                                               InitSourceOptions options)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public static InitSource fromS3Object(@NotNull
                                                                               String targetDirectory,
                                                                               @NotNull
                                                                               IBucket bucket,
                                                                               @NotNull
                                                                               String key)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public static InitSource fromUrl(@NotNull
                                                                          String targetDirectory,
                                                                          @NotNull
                                                                          String url,
                                                                          @Nullable
                                                                          InitSourceOptions options)

(experimental) Retrieve a URL and extract it into the given directory.

Parameters:: targetDirectory - This parameter is required.; url - This parameter is required.; options -

fromUrl

@Stability(value=Experimental)
 @NotNull
public static InitSource fromUrl(@NotNull
                                                                          String targetDirectory,
                                                                          @NotNull
                                                                          String url)

(experimental) Retrieve a URL and extract it into the given directory.

Parameters:: targetDirectory - This parameter is required.; url - This parameter is required.

getElementType
```
@Stability(value=Experimental)
 @NotNull
public String getElementType()
```
(experimental) Returns the init element type for this element.

Specified by:

getElementType in class InitElement

Class InitSource

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

InitSource

InitSource

InitSource

InitSource

Method Detail

fromAsset

fromAsset

fromExistingAsset

fromExistingAsset

fromGitHub

fromGitHub

fromGitHub

fromS3Object

fromS3Object

fromUrl

fromUrl

getElementType