Amazonka.AmplifyBackend.CreateBackend

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Creating a Request

data CreateBackend

The request body for CreateBackend.

See: newCreateBackend smart constructor.

Constructors

CreateBackend'

Fields

• resourceConfig :: Maybe ResourceConfig

  The resource configuration for creating a backend.

• resourceName :: Maybe Text

  The name of the resource.

• appId :: Text

  The app ID.

• backendEnvironmentName :: Text

  The name of the backend environment.

• appName :: Text

  The name of the app.

Instances

ToJSON CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

toJSON :: CreateBackend -> Value

toEncoding :: CreateBackend -> Encoding

toJSONList :: [CreateBackend] -> Value

toEncodingList :: [CreateBackend] -> Encoding

ToHeaders CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

toHeaders :: CreateBackend -> [Header]

ToPath CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

toPath :: CreateBackend -> ByteString

ToQuery CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

toQuery :: CreateBackend -> QueryString

AWSRequest CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Associated Types

type AWSResponse CreateBackend

Methods

request :: (Service -> Service) -> CreateBackend -> Request CreateBackend

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBackend -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackend)))

Generic CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Associated Types

type Rep CreateBackend :: Type -> Type

Methods

from :: CreateBackend -> Rep CreateBackend x

to :: Rep CreateBackend x -> CreateBackend

Read CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

readsPrec :: Int -> ReadS CreateBackend

readList :: ReadS [CreateBackend]

readPrec :: ReadPrec CreateBackend

readListPrec :: ReadPrec [CreateBackend]

Show CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

showsPrec :: Int -> CreateBackend -> ShowS

show :: CreateBackend -> String

showList :: [CreateBackend] -> ShowS

NFData CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

rnf :: CreateBackend -> ()

Eq CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

(==) :: CreateBackend -> CreateBackend -> Bool

(/=) :: CreateBackend -> CreateBackend -> Bool

Hashable CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

hashWithSalt :: Int -> CreateBackend -> Int

hash :: CreateBackend -> Int

type AWSResponse CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

type AWSResponse CreateBackend = CreateBackendResponse

type Rep CreateBackend

Defined in Amazonka.AmplifyBackend.CreateBackend

type Rep CreateBackend = D1 ('MetaData "CreateBackend" "Amazonka.AmplifyBackend.CreateBackend" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackend'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceConfig)) :*: S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateBackend

Arguments

:: Text

CreateBackend

-> Text

CreateBackend

-> Text

$sel:appName:CreateBackend'

-> CreateBackend

Create a value of CreateBackend 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:resourceConfig:CreateBackend', createBackend_resourceConfig - The resource configuration for creating a backend.

$sel:resourceName:CreateBackend', createBackend_resourceName - The name of the resource.

CreateBackend, createBackend_appId - The app ID.

CreateBackend, createBackend_backendEnvironmentName - The name of the backend environment.

$sel:appName:CreateBackend', createBackend_appName - The name of the app.

Request Lenses

createBackend_resourceConfig :: Lens' CreateBackend (Maybe ResourceConfig)

The resource configuration for creating a backend.

createBackend_resourceName :: Lens' CreateBackend (Maybe Text)

The name of the resource.

createBackend_appId :: Lens' CreateBackend Text

The app ID.

createBackend_backendEnvironmentName :: Lens' CreateBackend Text

The name of the backend environment.

createBackend_appName :: Lens' CreateBackend Text

The name of the app.

Destructuring the Response

data CreateBackendResponse

See: newCreateBackendResponse smart constructor.

Constructors

CreateBackendResponse'

Fields

• appId :: Maybe Text

  The app ID.

• backendEnvironmentName :: Maybe Text

  The name of the backend environment.

• error :: Maybe Text

  If the request fails, this error is returned.

• jobId :: Maybe Text

  The ID for the job.

• operation :: Maybe Text

  The name of the operation.

• status :: Maybe Text

  The current status of the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

Associated Types

type Rep CreateBackendResponse :: Type -> Type

Methods

from :: CreateBackendResponse -> Rep CreateBackendResponse x

to :: Rep CreateBackendResponse x -> CreateBackendResponse

Read CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

readsPrec :: Int -> ReadS CreateBackendResponse

readList :: ReadS [CreateBackendResponse]

readPrec :: ReadPrec CreateBackendResponse

readListPrec :: ReadPrec [CreateBackendResponse]

Show CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

showsPrec :: Int -> CreateBackendResponse -> ShowS

show :: CreateBackendResponse -> String

showList :: [CreateBackendResponse] -> ShowS

NFData CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

rnf :: CreateBackendResponse -> ()

Eq CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

Methods

(==) :: CreateBackendResponse -> CreateBackendResponse -> Bool

(/=) :: CreateBackendResponse -> CreateBackendResponse -> Bool

type Rep CreateBackendResponse

Defined in Amazonka.AmplifyBackend.CreateBackend

type Rep CreateBackendResponse = D1 ('MetaData "CreateBackendResponse" "Amazonka.AmplifyBackend.CreateBackend" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackendResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateBackendResponse

Arguments

:: Int

$sel:httpStatus:CreateBackendResponse'

-> CreateBackendResponse

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

CreateBackend, createBackendResponse_appId - The app ID.

CreateBackend, createBackendResponse_backendEnvironmentName - The name of the backend environment.

CreateBackendResponse, createBackendResponse_error - If the request fails, this error is returned.

CreateBackendResponse, createBackendResponse_jobId - The ID for the job.

CreateBackendResponse, createBackendResponse_operation - The name of the operation.

CreateBackendResponse, createBackendResponse_status - The current status of the request.

$sel:httpStatus:CreateBackendResponse', createBackendResponse_httpStatus - The response's http status code.

Response Lenses

createBackendResponse_appId :: Lens' CreateBackendResponse (Maybe Text)

The app ID.

createBackendResponse_backendEnvironmentName :: Lens' CreateBackendResponse (Maybe Text)

The name of the backend environment.

createBackendResponse_error :: Lens' CreateBackendResponse (Maybe Text)

If the request fails, this error is returned.

createBackendResponse_jobId :: Lens' CreateBackendResponse (Maybe Text)

The ID for the job.

createBackendResponse_operation :: Lens' CreateBackendResponse (Maybe Text)

The name of the operation.

createBackendResponse_status :: Lens' CreateBackendResponse (Maybe Text)

The current status of the request.

createBackendResponse_httpStatus :: Lens' CreateBackendResponse Int

The response's http status code.