String appId
The unique ID of the Amplify app.
String appArn
The Amazon Resource Name (ARN) of the Amplify app.
String name
The name for the Amplify app.
Map<K,V> tags
The tag for the Amplify app.
String description
The description for the Amplify app.
String repository
The Git repository for the Amplify app.
String platform
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic
server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify
Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
Date createTime
Creates a date and time for the Amplify app.
Date updateTime
Updates the date and time for the Amplify app.
String iamServiceRoleArn
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
Map<K,V> environmentVariables
The environment variables for the Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
String defaultDomain
The default domain for the Amplify app.
Boolean enableBranchAutoBuild
Enables the auto-building of branches for the Amplify app.
Boolean enableBranchAutoDeletion
Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
Boolean enableBasicAuth
Enables basic authorization for the Amplify app's branches.
String basicAuthCredentials
The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization
credentials and provide them in the format user:password.
List<E> customRules
Describes the custom redirect and rewrite rules for the Amplify app.
ProductionBranch productionBranch
Describes the information about a production branch of the Amplify app.
String buildSpec
Describes the content of the build specification (build spec) for the Amplify app.
String customHeaders
Describes the custom HTTP headers for the Amplify app.
Boolean enableAutoBranchCreation
Enables automated branch creation for the Amplify app.
List<E> autoBranchCreationPatterns
Describes the automated branch creation glob patterns for the Amplify app.
AutoBranchCreationConfig autoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.
String repositoryCloneMethod
This is for internal use.
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git
repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4
for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
String stage
Describes the current stage for the autocreated branch.
String framework
The framework for the autocreated branch.
Boolean enableAutoBuild
Enables auto building for the autocreated branch.
Map<K,V> environmentVariables
The environment variables for the autocreated branch.
String basicAuthCredentials
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization
credentials and provide them in the format user:password.
Boolean enableBasicAuth
Enables basic authorization for the autocreated branch.
Boolean enablePerformanceMode
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
String buildSpec
The build specification (build spec) for the autocreated branch.
Boolean enablePullRequestPreview
Enables pull request previews for the autocreated branch.
String pullRequestEnvironmentName
The Amplify environment name for the pull request.
String stackArn
The Amazon Resource Name (ARN) for the CloudFormation stack.
String backendEnvironmentArn
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
String environmentName
The name for a backend environment that is part of an Amplify app.
String stackName
The AWS CloudFormation stack name of a backend environment.
String deploymentArtifacts
The name of deployment artifacts.
Date createTime
The creation date and time for a backend environment that is part of an Amplify app.
Date updateTime
The last updated date and time for a backend environment that is part of an Amplify app.
String branchArn
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
String branchName
The name for the branch that is part of an Amplify app.
String description
The description for the branch that is part of an Amplify app.
Map<K,V> tags
The tag for the branch of an Amplify app.
String stage
The current stage for the branch that is part of an Amplify app.
String displayName
The display name for the branch. This is used as the default domain prefix.
Boolean enableNotification
Enables notifications for a branch that is part of an Amplify app.
Date createTime
The creation date and time for a branch that is part of an Amplify app.
Date updateTime
The last updated date and time for a branch that is part of an Amplify app.
Map<K,V> environmentVariables
The environment variables specific to a branch of an Amplify app.
Boolean enableAutoBuild
Enables auto-building on push for a branch of an Amplify app.
List<E> customDomains
The custom domains for a branch of an Amplify app.
String framework
The framework for a branch of an Amplify app.
String activeJobId
The ID of the active job for a branch of an Amplify app.
String totalNumberOfJobs
The total number of jobs that are part of an Amplify app.
Boolean enableBasicAuth
Enables basic authorization for a branch of an Amplify app.
Boolean enablePerformanceMode
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
String thumbnailUrl
The thumbnail URL for the branch of an Amplify app.
String basicAuthCredentials
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization
credentials and provide them in the format user:password.
String buildSpec
The build specification (build spec) content for the branch of an Amplify app.
String ttl
The content Time to Live (TTL) for the website in seconds.
List<E> associatedResources
A list of custom resources that are linked to this branch.
Boolean enablePullRequestPreview
Enables pull request previews for the branch.
String pullRequestEnvironmentName
The Amplify environment name for the pull request.
String destinationBranch
The destination branch if the branch is a pull request branch.
String sourceBranch
The source branch if the branch is a pull request branch.
String backendEnvironmentArn
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Backend backend
String name
The name of the Amplify app.
String description
The description of the Amplify app.
String repository
The Git repository for the Amplify app.
String platform
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic
server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify
Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
String iamServiceRoleArn
The AWS Identity and Access Management (IAM) service role for an Amplify app.
String oauthToken
The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To
authorize access to GitHub as your repository provider, use accessToken.
You must specify either oauthToken or accessToken when you create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
String accessToken
The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
Use accessToken for GitHub repositories only. To authorize access to a repository provider such as
Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
Map<K,V> environmentVariables
The environment variables map for an Amplify app.
For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
Boolean enableBranchAutoBuild
Enables the auto building of branches for an Amplify app.
Boolean enableBranchAutoDeletion
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
Boolean enableBasicAuth
Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
String basicAuthCredentials
The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials
and provide them in the format user:password.
List<E> customRules
The custom rewrite and redirect rules for an Amplify app.
Map<K,V> tags
The tag for an Amplify app.
String buildSpec
The build specification (build spec) for an Amplify app.
String customHeaders
The custom HTTP headers for an Amplify app.
Boolean enableAutoBranchCreation
Enables automated branch creation for an Amplify app.
List<E> autoBranchCreationPatterns
The automated branch creation glob patterns for an Amplify app.
AutoBranchCreationConfig autoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
App app
BackendEnvironment backendEnvironment
Describes the backend environment for an Amplify app.
String appId
The unique ID for an Amplify app.
String branchName
The name for the branch.
String description
The description for the branch.
String stage
Describes the current stage for the branch.
String framework
The framework for the branch.
Boolean enableNotification
Enables notifications for the branch.
Boolean enableAutoBuild
Enables auto building for the branch.
Map<K,V> environmentVariables
The environment variables for the branch.
String basicAuthCredentials
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and
provide them in the format user:password.
Boolean enableBasicAuth
Enables basic authorization for the branch.
Boolean enablePerformanceMode
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
Map<K,V> tags
The tag for the branch.
String buildSpec
The build specification (build spec) for the branch.
String ttl
The content Time To Live (TTL) for the website in seconds.
String displayName
The display name for a branch. This is used as the default domain prefix.
Boolean enablePullRequestPreview
Enables pull request previews for this branch.
String pullRequestEnvironmentName
The Amplify environment name for the pull request.
String backendEnvironmentArn
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Backend backend
The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
Branch branch
Describes the branch for an Amplify app, which maps to a third-party repository branch.
String appId
The unique ID for an Amplify app.
String branchName
The name of the branch to use for the job.
Map<K,V> fileMap
An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.
String jobId
The job ID for this deployment. will supply to start deployment api.
Map<K,V> fileUploadUrls
When the fileMap argument is provided in the request, fileUploadUrls will contain a map
of file names to upload URLs.
String zipUploadUrl
When the fileMap argument is not provided in the request, this zipUploadUrl is
returned.
String appId
The unique ID for an Amplify app.
String domainName
The domain name for the domain association.
Boolean enableAutoSubDomain
Enables the automated creation of subdomains for branches.
List<E> subDomainSettings
The setting for the subdomain.
List<E> autoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.
String autoSubDomainIAMRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
DomainAssociation domainAssociation
Describes the structure of a domain association, which associates a custom domain with an Amplify app.
Webhook webhook
Describes a webhook that connects repository events to an Amplify app.
String source
The source pattern for a URL rewrite or redirect rule.
String target
The target pattern for a URL rewrite or redirect rule.
String status
The status code for a URL rewrite or redirect rule.
Represents a 200 rewrite rule.
Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
Represents a 302 temporary redirect rule.
Represents a 404 redirect rule.
Represents a 404 rewrite rule.
String condition
The condition for a URL rewrite or redirect rule, such as a country code.
String appId
The unique ID for an Amplify app.
App app
BackendEnvironment backendEnvironment
Describes the backend environment for an Amplify app.
Branch branch
The branch for an Amplify app, which maps to a third-party repository branch.
DomainAssociation domainAssociation
JobSummary jobSummary
String webhookId
The unique ID for a webhook.
Webhook webhook
Describes a webhook that connects repository events to an Amplify app.
String domainAssociationArn
The Amazon Resource Name (ARN) for the domain association.
String domainName
The name of the domain.
Boolean enableAutoSubDomain
Enables the automated creation of subdomains for branches.
List<E> autoSubDomainCreationPatterns
Sets branch patterns for automatic subdomain creation.
String autoSubDomainIAMRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
String domainStatus
The current status of the domain association.
String statusReason
The reason for the current status of the domain association.
String certificateVerificationDNSRecord
The DNS record for certificate verification.
List<E> subDomains
The subdomains for the domain association.
Date startTime
The time at which the logs should start. The time range specified is inclusive of the start time.
Date endTime
The time at which the logs should end. The time range specified is inclusive of the end time.
String domainName
The name of the domain.
String appId
The unique ID for an Amplify app.
String logUrl
The pre-signed URL for the requested access logs.
String appId
The unique ID for an Amplify app.
App app
String artifactId
The unique ID for an artifact.
BackendEnvironment backendEnvironment
Describes the backend environment for an Amplify app.
Branch branch
DomainAssociation domainAssociation
Describes the structure of a domain association, which associates a custom domain with an Amplify app.
Job job
String webhookId
The unique ID for a webhook.
Webhook webhook
Describes the structure of a webhook.
JobSummary summary
Describes the summary for an execution job for an Amplify app.
List<E> steps
The execution steps for an execution job, for an Amplify app.
String jobArn
The Amazon Resource Name (ARN) for the job.
String jobId
The unique ID for the job.
String commitId
The commit ID from a third-party repository provider for the job.
String commitMessage
The commit message from a third-party repository provider for the job.
Date commitTime
The commit date and time for the job.
Date startTime
The start date and time for the job.
String status
The current status for the job.
Date endTime
The end date and time for the job.
String jobType
The type for the job. If the value is RELEASE, the job was manually released from its source by
using the StartJob API. If the value is RETRY, the job was manually retried using the
StartJob API. If the value is WEB_HOOK, the job was automatically triggered by
webhooks.
String appId
The unique ID for an Amplify app.
String branchName
The name of a branch that is part of an Amplify app.
String jobId
The unique ID for a job.
String nextToken
A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
Integer maxResults
The maximum number of records to list in a single response.
String appId
The unique ID for an Amplify app.
String environmentName
The name of the backend environment
String nextToken
A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.
Integer maxResults
The maximum number of records to list in a single response.
String appId
The unique ID for an Amplify app.
String nextToken
A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.
Integer maxResults
The maximum number of records to list in a single response.
String appId
The unique ID for an Amplify app.
String nextToken
A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.
Integer maxResults
The maximum number of records to list in a single response.
String appId
The unique ID for an Amplify app.
String branchName
The name of the branch to use for the request.
String nextToken
A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
Integer maxResults
The maximum number of records to list in a single response.
String resourceArn
The Amazon Resource Name (ARN) to use to list tags.
String appId
The unique ID for an Amplify app.
String nextToken
A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.
Integer maxResults
The maximum number of records to list in a single response.
String code
String appId
The unique ID for an Amplify app.
String branchName
The name of the branch to use for the job.
String jobId
The job ID for this deployment, generated by the create deployment request.
String sourceUrl
The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.
JobSummary jobSummary
The summary for the job.
String appId
The unique ID for an Amplify app.
String branchName
The name of the branch to use for the job.
String jobId
The unique ID for an existing job. This is required if the value of jobType is RETRY.
String jobType
Describes the type for the job. The job type RELEASE starts a new job with the latest change from
the specified branch. This value is available only for apps that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is RETRY, the
jobId is also required.
String jobReason
A descriptive reason for starting the job.
String commitId
The commit ID from a third-party repository provider for the job.
String commitMessage
The commit message from a third-party repository provider for the job.
Date commitTime
The commit date and time for the job.
JobSummary jobSummary
The summary for the job.
String stepName
The name of the execution step.
Date startTime
The start date and time of the execution step.
String status
The status of the execution step.
Date endTime
The end date and time of the execution step.
String logUrl
The URL to the logs for the execution step.
String artifactsUrl
The URL to the artifact for the execution step.
String testArtifactsUrl
The URL to the test artifact for the execution step.
String testConfigUrl
The URL to the test configuration for the execution step.
Map<K,V> screenshots
The list of screenshot URLs for the execution step, if relevant.
String statusReason
The reason for the current step status.
String context
The context for the current step. Includes a build image if the step is build.
JobSummary jobSummary
The summary for the job.
SubDomainSetting subDomainSetting
Describes the settings for the subdomain.
Boolean verified
The verified status of the subdomain
String dnsRecord
The DNS record for the subdomain.
String appId
The unique ID for an Amplify app.
String name
The name for an Amplify app.
String description
The description for an Amplify app.
String platform
The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic
server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify
Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
String iamServiceRoleArn
The AWS Identity and Access Management (IAM) service role for an Amplify app.
Map<K,V> environmentVariables
The environment variables for an Amplify app.
Boolean enableBranchAutoBuild
Enables branch auto-building for an Amplify app.
Boolean enableBranchAutoDeletion
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
Boolean enableBasicAuth
Enables basic authorization for an Amplify app.
String basicAuthCredentials
The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and
provide them in the format user:password.
List<E> customRules
The custom redirect and rewrite rules for an Amplify app.
String buildSpec
The build specification (build spec) for an Amplify app.
String customHeaders
The custom HTTP headers for an Amplify app.
Boolean enableAutoBranchCreation
Enables automated branch creation for an Amplify app.
List<E> autoBranchCreationPatterns
Describes the automated branch creation glob patterns for an Amplify app.
AutoBranchCreationConfig autoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
String repository
The name of the Git repository for an Amplify app.
String oauthToken
The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.
To authorize access to GitHub as your repository provider, use accessToken.
You must specify either oauthToken or accessToken when you update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
String accessToken
The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
Use accessToken for GitHub repositories only. To authorize access to a repository provider such as
Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
App app
Represents the updated Amplify app.
String appId
The unique ID for an Amplify app.
String branchName
The name of the branch.
String description
The description for the branch.
String framework
The framework for the branch.
String stage
Describes the current stage for the branch.
Boolean enableNotification
Enables notifications for the branch.
Boolean enableAutoBuild
Enables auto building for the branch.
Map<K,V> environmentVariables
The environment variables for the branch.
String basicAuthCredentials
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and
provide them in the format user:password.
Boolean enableBasicAuth
Enables basic authorization for the branch.
Boolean enablePerformanceMode
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
String buildSpec
The build specification (build spec) for the branch.
String ttl
The content Time to Live (TTL) for the website in seconds.
String displayName
The display name for a branch. This is used as the default domain prefix.
Boolean enablePullRequestPreview
Enables pull request previews for this branch.
String pullRequestEnvironmentName
The Amplify environment name for the pull request.
String backendEnvironmentArn
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Backend backend
The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
Branch branch
The branch for an Amplify app, which maps to a third-party repository branch.
String appId
The unique ID for an Amplify app.
String domainName
The name of the domain.
Boolean enableAutoSubDomain
Enables the automated creation of subdomains for branches.
List<E> subDomainSettings
Describes the settings for the subdomain.
List<E> autoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.
String autoSubDomainIAMRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
DomainAssociation domainAssociation
Describes a domain association, which associates a custom domain with an Amplify app.
Webhook webhook
Describes a webhook that connects repository events to an Amplify app.
String webhookArn
The Amazon Resource Name (ARN) for the webhook.
String webhookId
The ID of the webhook.
String webhookUrl
The URL of the webhook.
String branchName
The name for a branch that is part of an Amplify app.
String description
The description for a webhook.
Date createTime
The create date and time for a webhook.
Date updateTime
Updates the date and time for a webhook.
Copyright © 2024. All rights reserved.