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

Amazonka.Amplify.UpdateBranch

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Constructors

UpdateBranch'

Fields

backendEnvironmentArn :: Maybe Text
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
basicAuthCredentials :: Maybe (Sensitive Text)
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
buildSpec :: Maybe (Sensitive Text)
The build specification (build spec) for the branch.
description :: Maybe Text
The description for the branch.
displayName :: Maybe Text
The display name for a branch. This is used as the default domain prefix.
enableAutoBuild :: Maybe Bool
Enables auto building for the branch.
enableBasicAuth :: Maybe Bool
Enables basic authorization for the branch.
enableNotification :: Maybe Bool
Enables notifications for the branch.
enablePerformanceMode :: Maybe Bool
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.
enablePullRequestPreview :: Maybe Bool
Enables pull request previews for this branch.
environmentVariables :: Maybe (HashMap Text Text)
The environment variables for the branch.
framework :: Maybe Text
The framework for the branch.
pullRequestEnvironmentName :: Maybe Text
The Amplify environment name for the pull request.
stage :: Maybe Stage
Describes the current stage for the branch.
ttl :: Maybe Text
The content Time to Live (TTL) for the website in seconds.
appId :: Text
The unique ID for an Amplify app.
branchName :: Text
The name for the branch.

Instances

Instances details

ToJSON UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods toJSON :: UpdateBranch -> Value # toEncoding :: UpdateBranch -> Encoding # toJSONList :: [UpdateBranch] -> Value # toEncodingList :: [UpdateBranch] -> Encoding #
ToHeaders UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods toHeaders :: UpdateBranch -> [Header] #
ToPath UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods toPath :: UpdateBranch -> ByteString #
ToQuery UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods toQuery :: UpdateBranch -> QueryString #
AWSRequest UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Associated Types type AWSResponse UpdateBranch # Methods request :: (Service -> Service) -> UpdateBranch -> Request UpdateBranch # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateBranch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateBranch))) #
Generic UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Associated Types type Rep UpdateBranch :: Type -> Type # Methods from :: UpdateBranch -> Rep UpdateBranch x # to :: Rep UpdateBranch x -> UpdateBranch #
Show UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods showsPrec :: Int -> UpdateBranch -> ShowS # show :: UpdateBranch -> String # showList :: [UpdateBranch] -> ShowS #
NFData UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods rnf :: UpdateBranch -> () #
Eq UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods (==) :: UpdateBranch -> UpdateBranch -> Bool # (/=) :: UpdateBranch -> UpdateBranch -> Bool #
Hashable UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods hashWithSalt :: Int -> UpdateBranch -> Int # hash :: UpdateBranch -> Int #
type AWSResponse UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch type AWSResponse UpdateBranch = UpdateBranchResponse
type Rep UpdateBranch Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch type Rep UpdateBranch = D1 ('MetaData "UpdateBranch" "Amazonka.Amplify.UpdateBranch" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateBranch'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "backendEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "basicAuthCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "buildSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableAutoBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "enableBasicAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "enablePerformanceMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enablePullRequestPreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "environmentVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "framework") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "pullRequestEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Stage))) :: (S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateBranch Source #

Arguments

:: Text	`UpdateBranch`
-> Text	`UpdateBranch`
-> UpdateBranch

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.

Constructors

UpdateBranchResponse'
Fields httpStatus :: Int The response's http status code. branch :: Branch The branch for an Amplify app, which maps to a third-party repository branch.

Instances

Instances details

Generic UpdateBranchResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Associated Types type Rep UpdateBranchResponse :: Type -> Type # Methods from :: UpdateBranchResponse -> Rep UpdateBranchResponse x # to :: Rep UpdateBranchResponse x -> UpdateBranchResponse #
Show UpdateBranchResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods showsPrec :: Int -> UpdateBranchResponse -> ShowS # show :: UpdateBranchResponse -> String # showList :: [UpdateBranchResponse] -> ShowS #
NFData UpdateBranchResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods rnf :: UpdateBranchResponse -> () #
Eq UpdateBranchResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch Methods (==) :: UpdateBranchResponse -> UpdateBranchResponse -> Bool # (/=) :: UpdateBranchResponse -> UpdateBranchResponse -> Bool #
type Rep UpdateBranchResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateBranch type Rep UpdateBranchResponse = D1 ('MetaData "UpdateBranchResponse" "Amazonka.Amplify.UpdateBranch" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateBranchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "branch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Branch)))

newUpdateBranchResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateBranchResponse'`
-> Branch	`$sel:branch:UpdateBranchResponse'`
-> 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.