apigateway:create-or-update

Full name:

br.com.ingenieux:apigateway-maven-plugin:1.5.6:create-or-update

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
<curProject> MavenProject - (no description)
User property is: project.
<deploymentDescription> String - Stage Deployment Description
Default value is: Updated by apigateway-maven-plugin.
User property is: apigateway.stageDeploymentDescription.
<deploymentFile> File - Deployment File to Use (Swagger)
Default value is: ${project.build.outputDirectory}/META-INF/apigateway/apigateway-swagger.json.
User property is: apigateway.deploymentFile.
<overwriteDefinitions> Boolean - Overwrite Definitions (otherwise, merge)
Default value is: false.
User property is: apigateway.overwriteDefinitions.
<removeConflicting> boolean - Remove Conflicting Declarations? Disable for advanced usage
Default value is: true.
User property is: apigateway.removeConflicting.
<restApiName> String - (no description)
Default value is: ${project.artifactId}.
User property is: apigateway.restApiName.
<session> MavenSession - (no description)
Default value is: ${session}.
<skipInterpolate> Boolean - Overwrite Definitions (otherwise, merge)
Default value is: false.
User property is: apigateway.overwriteDefinitions.
<stageName> String - (no description)
Default value is: dev.
User property is: apigateway.stageName.
<stageNameDescription> String - Stage Name Description
Default value is: ${apigateway.stageName} stage.
User property is: apigateway.stageNameDescription.

Optional Parameters

Name Type Since Description
<cacheClusterEnabled> Boolean - Cache Cluster Enabled (when creating a new stage)
Default value is: false.
User property is: apigateway.cacheClusterEnabled.
<cacheClusterSize> String - Cache Cluster Size (when creating a new stage)
User property is: apigateway.cacheClusterSize.
<credentialId> String - The credential id (on ~/.aws/credentials file) to use)
Default value is: default.
User property is: beanstalker.credentialId.
<ignoreExceptions> boolean - Ignore Exceptions?
Default value is: false.
User property is: beanstalker.ignoreExceptions.
<lambdasFile> File - Deployment File to Use (Lambda)
Default value is: ${project.build.outputDirectory}/META-INF/lambda-definitions.json.
User property is: apigateway.lambdasFile.
<parameters> Map - Parameters
User property is: apigateway.parameters.
<regionName> String -

Service region e.g. "us-east-1"

See this list for reference.


User property is: beanstalker.region.
<restApiDescription> String - Rest API Description
Default value is: API for ${project.artifactId}.
User property is: apigateway.restApiDescription.
<serverId> String - The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
Default value is: aws.amazon.com.
User property is: beanstalker.serverId.
<stageVariables> Map - New Stage Definitions
<verbose> boolean - Verbose Logging?
Default value is: false.
User property is: beanstalker.verbose.

Parameter Details

<cacheClusterEnabled>

Cache Cluster Enabled (when creating a new stage)
  • Type: java.lang.Boolean
  • Required: No
  • User Property: apigateway.cacheClusterEnabled
  • Default: false

<cacheClusterSize>

Cache Cluster Size (when creating a new stage)
  • Type: java.lang.String
  • Required: No
  • User Property: apigateway.cacheClusterSize

<credentialId>

The credential id (on ~/.aws/credentials file) to use)
  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.credentialId
  • Default: default

<curProject>

(no description)
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • User Property: project

<deploymentDescription>

Stage Deployment Description
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.stageDeploymentDescription
  • Default: Updated by apigateway-maven-plugin

<deploymentFile>

Deployment File to Use (Swagger)
  • Type: java.io.File
  • Required: Yes
  • User Property: apigateway.deploymentFile
  • Default: ${project.build.outputDirectory}/META-INF/apigateway/apigateway-swagger.json

<ignoreExceptions>

Ignore Exceptions?
  • Type: boolean
  • Required: No
  • User Property: beanstalker.ignoreExceptions
  • Default: false

<lambdasFile>

Deployment File to Use (Lambda)
  • Type: java.io.File
  • Required: No
  • User Property: apigateway.lambdasFile
  • Default: ${project.build.outputDirectory}/META-INF/lambda-definitions.json

<overwriteDefinitions>

Overwrite Definitions (otherwise, merge)
  • Type: java.lang.Boolean
  • Required: Yes
  • User Property: apigateway.overwriteDefinitions
  • Default: false

<parameters>

Parameters
  • Type: java.util.Map
  • Required: No
  • User Property: apigateway.parameters

<regionName>

Service region e.g. "us-east-1"

See this list for reference.

  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.region

<removeConflicting>

Remove Conflicting Declarations? Disable for advanced usage
  • Type: boolean
  • Required: Yes
  • User Property: apigateway.removeConflicting
  • Default: true

<restApiDescription>

Rest API Description
  • Type: java.lang.String
  • Required: No
  • User Property: apigateway.restApiDescription
  • Default: API for ${project.artifactId}

<restApiName>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.restApiName
  • Default: ${project.artifactId}

<serverId>

The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.serverId
  • Default: aws.amazon.com

<session>

(no description)
  • Type: org.apache.maven.execution.MavenSession
  • Required: Yes
  • Default: ${session}

<skipInterpolate>

Overwrite Definitions (otherwise, merge)
  • Type: java.lang.Boolean
  • Required: Yes
  • User Property: apigateway.overwriteDefinitions
  • Default: false

<stageName>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.stageName
  • Default: dev

<stageNameDescription>

Stage Name Description
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.stageNameDescription
  • Default: ${apigateway.stageName} stage

<stageVariables>

New Stage Definitions
  • Type: java.util.Map
  • Required: No

<verbose>

Verbose Logging?
  • Type: boolean
  • Required: No
  • User Property: beanstalker.verbose
  • Default: false