Amazonka.BackupGateway.CreateGateway

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Creating a Request

data CreateGateway

See: newCreateGateway smart constructor.

Constructors

CreateGateway'

Fields

• tags :: Maybe [Tag]

  A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

• activationKey :: Text

  The activation key of the created gateway.

• gatewayDisplayName :: Text

  The display name of the created gateway.

• gatewayType :: GatewayType

  The type of created gateway.

Instances

ToJSON CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

toJSON :: CreateGateway -> Value

toEncoding :: CreateGateway -> Encoding

toJSONList :: [CreateGateway] -> Value

toEncodingList :: [CreateGateway] -> Encoding

ToHeaders CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

toHeaders :: CreateGateway -> [Header]

ToPath CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

toPath :: CreateGateway -> ByteString

ToQuery CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

toQuery :: CreateGateway -> QueryString

AWSRequest CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Associated Types

type AWSResponse CreateGateway

Methods

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

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

Generic CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Associated Types

type Rep CreateGateway :: Type -> Type

Methods

from :: CreateGateway -> Rep CreateGateway x

to :: Rep CreateGateway x -> CreateGateway

Read CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

readsPrec :: Int -> ReadS CreateGateway

readList :: ReadS [CreateGateway]

readPrec :: ReadPrec CreateGateway

readListPrec :: ReadPrec [CreateGateway]

Show CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

showsPrec :: Int -> CreateGateway -> ShowS

show :: CreateGateway -> String

showList :: [CreateGateway] -> ShowS

NFData CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

rnf :: CreateGateway -> ()

Eq CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

(==) :: CreateGateway -> CreateGateway -> Bool

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

Hashable CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

Methods

hashWithSalt :: Int -> CreateGateway -> Int

hash :: CreateGateway -> Int

type AWSResponse CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

type AWSResponse CreateGateway = CreateGatewayResponse

type Rep CreateGateway

Defined in Amazonka.BackupGateway.CreateGateway

type Rep CreateGateway = D1 ('MetaData "CreateGateway" "Amazonka.BackupGateway.CreateGateway" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "CreateGateway'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "activationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "gatewayDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "gatewayType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayType))))

newCreateGateway

Arguments

:: Text

$sel:activationKey:CreateGateway'

-> Text

CreateGateway

-> GatewayType

CreateGateway

-> CreateGateway

Create a value of CreateGateway 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:tags:CreateGateway', createGateway_tags - A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

$sel:activationKey:CreateGateway', createGateway_activationKey - The activation key of the created gateway.

CreateGateway, createGateway_gatewayDisplayName - The display name of the created gateway.

CreateGateway, createGateway_gatewayType - The type of created gateway.

Request Lenses

createGateway_tags :: Lens' CreateGateway (Maybe [Tag])

A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

createGateway_activationKey :: Lens' CreateGateway Text

The activation key of the created gateway.

createGateway_gatewayDisplayName :: Lens' CreateGateway Text

The display name of the created gateway.

createGateway_gatewayType :: Lens' CreateGateway GatewayType

The type of created gateway.

Destructuring the Response

data CreateGatewayResponse

See: newCreateGatewayResponse smart constructor.

Constructors

CreateGatewayResponse'

Fields

• gatewayArn :: Maybe Text

  The Amazon Resource Name (ARN) of the gateway you create.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

Associated Types

type Rep CreateGatewayResponse :: Type -> Type

Methods

from :: CreateGatewayResponse -> Rep CreateGatewayResponse x

to :: Rep CreateGatewayResponse x -> CreateGatewayResponse

Read CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

Methods

readsPrec :: Int -> ReadS CreateGatewayResponse

readList :: ReadS [CreateGatewayResponse]

readPrec :: ReadPrec CreateGatewayResponse

readListPrec :: ReadPrec [CreateGatewayResponse]

Show CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

Methods

showsPrec :: Int -> CreateGatewayResponse -> ShowS

show :: CreateGatewayResponse -> String

showList :: [CreateGatewayResponse] -> ShowS

NFData CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

Methods

rnf :: CreateGatewayResponse -> ()

Eq CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

Methods

(==) :: CreateGatewayResponse -> CreateGatewayResponse -> Bool

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

type Rep CreateGatewayResponse

Defined in Amazonka.BackupGateway.CreateGateway

type Rep CreateGatewayResponse = D1 ('MetaData "CreateGatewayResponse" "Amazonka.BackupGateway.CreateGateway" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "CreateGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGatewayResponse

Arguments

:: Int

$sel:httpStatus:CreateGatewayResponse'

-> CreateGatewayResponse

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

CreateGatewayResponse, createGatewayResponse_gatewayArn - The Amazon Resource Name (ARN) of the gateway you create.

$sel:httpStatus:CreateGatewayResponse', createGatewayResponse_httpStatus - The response's http status code.

Response Lenses

createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse (Maybe Text)

The Amazon Resource Name (ARN) of the gateway you create.

createGatewayResponse_httpStatus :: Lens' CreateGatewayResponse Int

The response's http status code.