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.CreateBranch

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new branch for an Amplify app.

Synopsis

data CreateBranch = CreateBranch' {
- 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
- tags :: Maybe (HashMap Text Text)
- ttl :: Maybe Text
- appId :: Text
- branchName :: Text
}
newCreateBranch :: Text -> Text -> CreateBranch
createBranch_backendEnvironmentArn :: Lens' CreateBranch (Maybe Text)
createBranch_basicAuthCredentials :: Lens' CreateBranch (Maybe Text)
createBranch_buildSpec :: Lens' CreateBranch (Maybe Text)
createBranch_description :: Lens' CreateBranch (Maybe Text)
createBranch_displayName :: Lens' CreateBranch (Maybe Text)
createBranch_enableAutoBuild :: Lens' CreateBranch (Maybe Bool)
createBranch_enableBasicAuth :: Lens' CreateBranch (Maybe Bool)
createBranch_enableNotification :: Lens' CreateBranch (Maybe Bool)
createBranch_enablePerformanceMode :: Lens' CreateBranch (Maybe Bool)
createBranch_enablePullRequestPreview :: Lens' CreateBranch (Maybe Bool)
createBranch_environmentVariables :: Lens' CreateBranch (Maybe (HashMap Text Text))
createBranch_framework :: Lens' CreateBranch (Maybe Text)
createBranch_pullRequestEnvironmentName :: Lens' CreateBranch (Maybe Text)
createBranch_stage :: Lens' CreateBranch (Maybe Stage)
createBranch_tags :: Lens' CreateBranch (Maybe (HashMap Text Text))
createBranch_ttl :: Lens' CreateBranch (Maybe Text)
createBranch_appId :: Lens' CreateBranch Text
createBranch_branchName :: Lens' CreateBranch Text
data CreateBranchResponse = CreateBranchResponse' {
- httpStatus :: Int
- branch :: Branch
}
newCreateBranchResponse :: Int -> Branch -> CreateBranchResponse
createBranchResponse_httpStatus :: Lens' CreateBranchResponse Int
createBranchResponse_branch :: Lens' CreateBranchResponse Branch

Creating a Request

data CreateBranch Source #

The request structure for the create branch request.

See: newCreateBranch smart constructor.

Constructors

CreateBranch'

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.
tags :: Maybe (HashMap Text Text)
The tag 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 CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods toJSON :: CreateBranch -> Value # toEncoding :: CreateBranch -> Encoding # toJSONList :: [CreateBranch] -> Value # toEncodingList :: [CreateBranch] -> Encoding #
ToHeaders CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods toHeaders :: CreateBranch -> [Header] #
ToPath CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods toPath :: CreateBranch -> ByteString #
ToQuery CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods toQuery :: CreateBranch -> QueryString #
AWSRequest CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Associated Types type AWSResponse CreateBranch # Methods request :: (Service -> Service) -> CreateBranch -> Request CreateBranch # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBranch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBranch))) #
Generic CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Associated Types type Rep CreateBranch :: Type -> Type # Methods from :: CreateBranch -> Rep CreateBranch x # to :: Rep CreateBranch x -> CreateBranch #
Show CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods showsPrec :: Int -> CreateBranch -> ShowS # show :: CreateBranch -> String # showList :: [CreateBranch] -> ShowS #
NFData CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods rnf :: CreateBranch -> () #
Eq CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods (==) :: CreateBranch -> CreateBranch -> Bool # (/=) :: CreateBranch -> CreateBranch -> Bool #
Hashable CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch Methods hashWithSalt :: Int -> CreateBranch -> Int # hash :: CreateBranch -> Int #
type AWSResponse CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch type AWSResponse CreateBranch = CreateBranchResponse
type Rep CreateBranch Source #
Instance details Defined in Amazonka.Amplify.CreateBranch type Rep CreateBranch = D1 ('MetaData "CreateBranch" "Amazonka.Amplify.CreateBranch" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateBranch'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (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)))))))

newCreateBranch Source #

Arguments

:: Text	`CreateBranch`
-> Text	`CreateBranch`
-> CreateBranch

Create a value of CreateBranch 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:

CreateBranch, createBranch_backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

CreateBranch, createBranch_basicAuthCredentials - The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

CreateBranch, createBranch_buildSpec - The build specification (build spec) for the branch.

CreateBranch, createBranch_description - The description for the branch.

CreateBranch, createBranch_displayName - The display name for a branch. This is used as the default domain prefix.

CreateBranch, createBranch_enableAutoBuild - Enables auto building for the branch.

CreateBranch, createBranch_enableBasicAuth - Enables basic authorization for the branch.

CreateBranch, createBranch_enableNotification - Enables notifications for the branch.

CreateBranch, createBranch_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.

CreateBranch, createBranch_enablePullRequestPreview - Enables pull request previews for this branch.

CreateBranch, createBranch_environmentVariables - The environment variables for the branch.

CreateBranch, createBranch_framework - The framework for the branch.

CreateBranch, createBranch_pullRequestEnvironmentName - The Amplify environment name for the pull request.

CreateBranch, createBranch_stage - Describes the current stage for the branch.

CreateBranch, createBranch_tags - The tag for the branch.

CreateBranch, createBranch_ttl - The content Time To Live (TTL) for the website in seconds.

CreateBranch, createBranch_appId - The unique ID for an Amplify app.

CreateBranch, createBranch_branchName - The name for the branch.

Request Lenses

createBranch_backendEnvironmentArn :: Lens' CreateBranch (Maybe Text) Source #

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

createBranch_basicAuthCredentials :: Lens' CreateBranch (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.

createBranch_buildSpec :: Lens' CreateBranch (Maybe Text) Source #

The build specification (build spec) for the branch.

createBranch_description :: Lens' CreateBranch (Maybe Text) Source #

The description for the branch.

createBranch_displayName :: Lens' CreateBranch (Maybe Text) Source #

The display name for a branch. This is used as the default domain prefix.

createBranch_enableAutoBuild :: Lens' CreateBranch (Maybe Bool) Source #

Enables auto building for the branch.

createBranch_enableBasicAuth :: Lens' CreateBranch (Maybe Bool) Source #

Enables basic authorization for the branch.

createBranch_enableNotification :: Lens' CreateBranch (Maybe Bool) Source #

Enables notifications for the branch.

createBranch_enablePerformanceMode :: Lens' CreateBranch (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.

createBranch_enablePullRequestPreview :: Lens' CreateBranch (Maybe Bool) Source #

Enables pull request previews for this branch.

createBranch_environmentVariables :: Lens' CreateBranch (Maybe (HashMap Text Text)) Source #

The environment variables for the branch.

createBranch_framework :: Lens' CreateBranch (Maybe Text) Source #

The framework for the branch.

createBranch_pullRequestEnvironmentName :: Lens' CreateBranch (Maybe Text) Source #

The Amplify environment name for the pull request.

createBranch_stage :: Lens' CreateBranch (Maybe Stage) Source #

Describes the current stage for the branch.

createBranch_tags :: Lens' CreateBranch (Maybe (HashMap Text Text)) Source #

The tag for the branch.

createBranch_ttl :: Lens' CreateBranch (Maybe Text) Source #

The content Time To Live (TTL) for the website in seconds.

createBranch_appId :: Lens' CreateBranch Text Source #

The unique ID for an Amplify app.

createBranch_branchName :: Lens' CreateBranch Text Source #

The name for the branch.

Destructuring the Response

data CreateBranchResponse Source #

The result structure for create branch request.

See: newCreateBranchResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateBranchResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBranchResponse'`
-> Branch	`$sel:branch:CreateBranchResponse'`
-> CreateBranchResponse

Create a value of CreateBranchResponse 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:CreateBranchResponse', createBranchResponse_httpStatus - The response's http status code.

$sel:branch:CreateBranchResponse', createBranchResponse_branch - Describes the branch for an Amplify app, which maps to a third-party repository branch.

Response Lenses

createBranchResponse_httpStatus :: Lens' CreateBranchResponse Int Source #

The response's http status code.

createBranchResponse_branch :: Lens' CreateBranchResponse Branch Source #

Describes the branch for an Amplify app, which maps to a third-party repository branch.