Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates a branch for an Amplify app.
Synopsis
- data UpdateBranch = UpdateBranch' {
- backendEnvironmentArn :: Maybe Text
- basicAuthCredentials :: Maybe (Sensitive Text)
- buildSpec :: Maybe (Sensitive Text)
- description :: Maybe Text
- displayName :: Maybe Text
- enableAutoBuild :: Maybe Bool
- enableBasicAuth :: Maybe Bool
- enableNotification :: Maybe Bool
- enablePerformanceMode :: Maybe Bool
- enablePullRequestPreview :: Maybe Bool
- environmentVariables :: Maybe (HashMap Text Text)
- framework :: Maybe Text
- pullRequestEnvironmentName :: Maybe Text
- stage :: Maybe Stage
- ttl :: Maybe Text
- appId :: Text
- branchName :: Text
- newUpdateBranch :: Text -> Text -> UpdateBranch
- updateBranch_backendEnvironmentArn :: Lens' UpdateBranch (Maybe Text)
- updateBranch_basicAuthCredentials :: Lens' UpdateBranch (Maybe Text)
- updateBranch_buildSpec :: Lens' UpdateBranch (Maybe Text)
- updateBranch_description :: Lens' UpdateBranch (Maybe Text)
- updateBranch_displayName :: Lens' UpdateBranch (Maybe Text)
- updateBranch_enableAutoBuild :: Lens' UpdateBranch (Maybe Bool)
- updateBranch_enableBasicAuth :: Lens' UpdateBranch (Maybe Bool)
- updateBranch_enableNotification :: Lens' UpdateBranch (Maybe Bool)
- updateBranch_enablePerformanceMode :: Lens' UpdateBranch (Maybe Bool)
- updateBranch_enablePullRequestPreview :: Lens' UpdateBranch (Maybe Bool)
- updateBranch_environmentVariables :: Lens' UpdateBranch (Maybe (HashMap Text Text))
- updateBranch_framework :: Lens' UpdateBranch (Maybe Text)
- updateBranch_pullRequestEnvironmentName :: Lens' UpdateBranch (Maybe Text)
- updateBranch_stage :: Lens' UpdateBranch (Maybe Stage)
- updateBranch_ttl :: Lens' UpdateBranch (Maybe Text)
- updateBranch_appId :: Lens' UpdateBranch Text
- updateBranch_branchName :: Lens' UpdateBranch Text
- data UpdateBranchResponse = UpdateBranchResponse' {
- httpStatus :: Int
- branch :: Branch
- newUpdateBranchResponse :: Int -> Branch -> UpdateBranchResponse
- updateBranchResponse_httpStatus :: Lens' UpdateBranchResponse Int
- updateBranchResponse_branch :: Lens' UpdateBranchResponse Branch
Creating a Request
data UpdateBranch Source #
The request structure for the update branch request.
See: newUpdateBranch
smart constructor.
UpdateBranch' | |
|
Instances
Create a value of UpdateBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateBranch
, updateBranch_backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of
an Amplify app.
UpdateBranch
, updateBranch_basicAuthCredentials
- The basic authorization credentials for the branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
UpdateBranch
, updateBranch_buildSpec
- The build specification (build spec) for the branch.
UpdateBranch
, updateBranch_description
- The description for the branch.
UpdateBranch
, updateBranch_displayName
- The display name for a branch. This is used as the default domain
prefix.
UpdateBranch
, updateBranch_enableAutoBuild
- Enables auto building for the branch.
UpdateBranch
, updateBranch_enableBasicAuth
- Enables basic authorization for the branch.
UpdateBranch
, updateBranch_enableNotification
- Enables notifications for the branch.
UpdateBranch
, updateBranch_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.
UpdateBranch
, updateBranch_enablePullRequestPreview
- Enables pull request previews for this branch.
UpdateBranch
, updateBranch_environmentVariables
- The environment variables for the branch.
UpdateBranch
, updateBranch_framework
- The framework for the branch.
UpdateBranch
, updateBranch_pullRequestEnvironmentName
- The Amplify environment name for the pull request.
UpdateBranch
, updateBranch_stage
- Describes the current stage for the branch.
UpdateBranch
, updateBranch_ttl
- The content Time to Live (TTL) for the website in seconds.
UpdateBranch
, updateBranch_appId
- The unique ID for an Amplify app.
UpdateBranch
, updateBranch_branchName
- The name for the branch.
Request Lenses
updateBranch_backendEnvironmentArn :: Lens' UpdateBranch (Maybe Text) Source #
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
updateBranch_basicAuthCredentials :: Lens' UpdateBranch (Maybe Text) Source #
The basic authorization credentials for the branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
updateBranch_buildSpec :: Lens' UpdateBranch (Maybe Text) Source #
The build specification (build spec) for the branch.
updateBranch_description :: Lens' UpdateBranch (Maybe Text) Source #
The description for the branch.
updateBranch_displayName :: Lens' UpdateBranch (Maybe Text) Source #
The display name for a branch. This is used as the default domain prefix.
updateBranch_enableAutoBuild :: Lens' UpdateBranch (Maybe Bool) Source #
Enables auto building for the branch.
updateBranch_enableBasicAuth :: Lens' UpdateBranch (Maybe Bool) Source #
Enables basic authorization for the branch.
updateBranch_enableNotification :: Lens' UpdateBranch (Maybe Bool) Source #
Enables notifications for the branch.
updateBranch_enablePerformanceMode :: Lens' UpdateBranch (Maybe Bool) Source #
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.
updateBranch_enablePullRequestPreview :: Lens' UpdateBranch (Maybe Bool) Source #
Enables pull request previews for this branch.
updateBranch_environmentVariables :: Lens' UpdateBranch (Maybe (HashMap Text Text)) Source #
The environment variables for the branch.
updateBranch_framework :: Lens' UpdateBranch (Maybe Text) Source #
The framework for the branch.
updateBranch_pullRequestEnvironmentName :: Lens' UpdateBranch (Maybe Text) Source #
The Amplify environment name for the pull request.
updateBranch_stage :: Lens' UpdateBranch (Maybe Stage) Source #
Describes the current stage for the branch.
updateBranch_ttl :: Lens' UpdateBranch (Maybe Text) Source #
The content Time to Live (TTL) for the website in seconds.
updateBranch_appId :: Lens' UpdateBranch Text Source #
The unique ID for an Amplify app.
updateBranch_branchName :: Lens' UpdateBranch Text Source #
The name for the branch.
Destructuring the Response
data UpdateBranchResponse Source #
The result structure for the update branch request.
See: newUpdateBranchResponse
smart constructor.
UpdateBranchResponse' | |
|
Instances
newUpdateBranchResponse Source #
:: Int | |
-> Branch | |
-> UpdateBranchResponse |
Create a value of UpdateBranchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateBranchResponse'
, updateBranchResponse_httpStatus
- The response's http status code.
$sel:branch:UpdateBranchResponse'
, updateBranchResponse_branch
- The branch for an Amplify app, which maps to a third-party repository
branch.
Response Lenses
updateBranchResponse_httpStatus :: Lens' UpdateBranchResponse Int Source #
The response's http status code.
updateBranchResponse_branch :: Lens' UpdateBranchResponse Branch Source #
The branch for an Amplify app, which maps to a third-party repository branch.