[ aws . amplifybackend ]

create-backend-storage

Description

Creates a backend storage resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-backend-storage
--app-id <value>
--backend-environment-name <value>
--resource-config <value>
--resource-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The app ID.

--backend-environment-name (string)

The name of the backend environment.

--resource-config (structure)

The resource configuration for creating backend storage.

BucketName -> (string)

The name of the S3 bucket.

Permissions -> (structure)

The authorization configuration for the storage S3 bucket.

Authenticated -> (list)

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

(string)

UnAuthenticated -> (list)

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

(string)

ServiceName -> (string)

The name of the storage service.

Shorthand Syntax:

BucketName=string,Permissions={Authenticated=[string,string],UnAuthenticated=[string,string]},ServiceName=string

JSON Syntax:

{
  "BucketName": "string",
  "Permissions": {
    "Authenticated": ["READ"|"CREATE_AND_UPDATE"|"DELETE", ...],
    "UnAuthenticated": ["READ"|"CREATE_AND_UPDATE"|"DELETE", ...]
  },
  "ServiceName": "S3"
}

--resource-name (string)

The name of the storage resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AppId -> (string)

The app ID.

BackendEnvironmentName -> (string)

The name of the backend environment.

JobId -> (string)

The ID for the job.

Status -> (string)

The current status of the request.