ws.osiris.awsdeploy

Interface DeployableProject

public DeployableProject

Implemented for each build system to hook into the project configuration.

The configuration allows the code and CloudFormation template to be generated and the project to be deployed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeployableProject.DefaultImpls Implemented for each build system to hook into the project configuration.

Method Summary

Modifier and Type	Method and Description
ws.osiris.aws.ApiFactory<?>	createApiFactory(java.lang.ClassLoader parentClassLoader) Returns a factory that can build the API, the components and the application configuration.
java.util.Map<java.lang.String,java.lang.String>	deploy()
void	generateCloudFormation()
java.nio.file.Path	generatedTemplatePath(java.lang.String appName)
java.lang.String	getAwsProfile() The name of the AWS profile; if not specified the default chain is used to find the profile and region.
java.nio.file.Path	getBuildDir() The root of the build directory.
java.lang.String	getEnvironmentName() The name of the environment into which the code is being deployed; used in resource and bucket names.
java.nio.file.Path	getJarBuildDir() The directory where jar files are built.
java.lang.String	getName() The project name; must be specified by the user in the Maven or Gradle project.
java.lang.String	getRootPackage() The root package of the application; used when generating the CloudFormation template.
java.nio.file.Path	getSourceDir() The root of the main source directory; normally src/main.
java.lang.String	getStaticFilesDirectory() The directory containing the static files; null if the API doesn't serve static files.
java.lang.String	getVersion() The project version; Maven requires a version but it's optional in Gradle.

Method Detail

getName

java.lang.String getName()

The project name; must be specified by the user in the Maven or Gradle project.

getVersion

java.lang.String getVersion()

The project version; Maven requires a version but it's optional in Gradle.

getBuildDir

java.nio.file.Path getBuildDir()

The root of the build directory.

getJarBuildDir

java.nio.file.Path getJarBuildDir()

The directory where jar files are built.

getSourceDir

java.nio.file.Path getSourceDir()

The root of the main source directory; normally src/main.

getRootPackage

java.lang.String getRootPackage()

The root package of the application; used when generating the CloudFormation template.

getEnvironmentName

java.lang.String getEnvironmentName()

The name of the environment into which the code is being deployed; used in resource and bucket names.

getStaticFilesDirectory

java.lang.String getStaticFilesDirectory()

The directory containing the static files; null if the API doesn't serve static files.

getAwsProfile

java.lang.String getAwsProfile()

The name of the AWS profile; if not specified the default chain is used to find the profile and region.

createApiFactory

ws.osiris.aws.ApiFactory<?> createApiFactory(java.lang.ClassLoader parentClassLoader)

Returns a factory that can build the API, the components and the application configuration.

generateCloudFormation

void generateCloudFormation()

generatedTemplatePath

java.nio.file.Path generatedTemplatePath(java.lang.String appName)

deploy

java.util.Map<java.lang.String,java.lang.String> deploy()