Interface StartDeploymentRequest.Builder

All Superinterfaces:
AmplifyRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>, SdkBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartDeploymentRequest
@Mutable @NotThreadSafe public static interface StartDeploymentRequest.Builder extends AmplifyRequest.Builder, SdkPojo, CopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>

  • Method Details

    • appId

      StartDeploymentRequest.Builder appId(String appId)

      The unique ID for an Amplify app.

      Parameters:
      appId - The unique ID for an Amplify app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • branchName

      StartDeploymentRequest.Builder branchName(String branchName)

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

      Parameters:
      branchName - The name of the branch to use for the deployment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobId

      StartDeploymentRequest.Builder jobId(String jobId)

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

      Parameters:
      jobId - The job ID for this deployment that is generated by the CreateDeployment request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceUrl

      StartDeploymentRequest.Builder sourceUrl(String sourceUrl)

      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.

      Parameters:
      sourceUrl - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceUrlType

      StartDeploymentRequest.Builder sourceUrlType(String sourceUrlType)

      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.

      Parameters:
      sourceUrlType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceUrlType

      StartDeploymentRequest.Builder sourceUrlType(SourceUrlType sourceUrlType)

      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.

      Parameters:
      sourceUrlType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartDeploymentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.