@aws-sdk/client-amplify

StartDeploymentRequest Interface

The request structure for the start a deployment request.

Members

Name
Type
Details
appId Requiredstring | undefined

The unique ID for an Amplify app.

branchName Requiredstring | undefined

The name of the branch to use for the deployment job.

jobId string | undefined

The job ID for this deployment that is generated by the CreateDeployment request.

sourceUrl string | undefined

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

sourceUrlType SourceUrlType | undefined

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

Full Signature

export interface StartDeploymentRequest