[ aws . appstream ]

create-app-block

Description

Creates an app block.

App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.

This is only supported for Elastic fleets.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-app-block
--name <value>
[--description <value>]
[--display-name <value>]
--source-s3-location <value>
--setup-script-details <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the app block.

--description (string)

The description of the app block.

--display-name (string)

The display name of the app block. This is not displayed to the user.

--source-s3-location (structure)

The source S3 location of the app block.

S3Bucket -> (string)

The S3 bucket of the S3 object.

S3Key -> (string)

The S3 key of the S3 object.

Shorthand Syntax:

S3Bucket=string,S3Key=string

JSON Syntax:

{
  "S3Bucket": "string",
  "S3Key": "string"
}

--setup-script-details (structure)

The setup script details of the app block.

ScriptS3Location -> (structure)

The S3 object location for the script.

S3Bucket -> (string)

The S3 bucket of the S3 object.

S3Key -> (string)

The S3 key of the S3 object.

ExecutablePath -> (string)

The run path for the script.

ExecutableParameters -> (string)

The runtime parameters passed to the run path for the script.

TimeoutInSeconds -> (integer)

The run timeout, in seconds, for the script.

Shorthand Syntax:

ScriptS3Location={S3Bucket=string,S3Key=string},ExecutablePath=string,ExecutableParameters=string,TimeoutInSeconds=integer

JSON Syntax:

{
  "ScriptS3Location": {
    "S3Bucket": "string",
    "S3Key": "string"
  },
  "ExecutablePath": "string",
  "ExecutableParameters": "string",
  "TimeoutInSeconds": integer
}

--tags (map)

The tags assigned to the app block.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

AppBlock -> (structure)

The app block.

Name -> (string)

The name of the app block.

Arn -> (string)

The ARN of the app block.

Description -> (string)

The description of the app block.

DisplayName -> (string)

The display name of the app block.

SourceS3Location -> (structure)

The source S3 location of the app block.

S3Bucket -> (string)

The S3 bucket of the S3 object.

S3Key -> (string)

The S3 key of the S3 object.

SetupScriptDetails -> (structure)

The setup script details of the app block.

ScriptS3Location -> (structure)

The S3 object location for the script.

S3Bucket -> (string)

The S3 bucket of the S3 object.

S3Key -> (string)

The S3 key of the S3 object.

ExecutablePath -> (string)

The run path for the script.

ExecutableParameters -> (string)

The runtime parameters passed to the run path for the script.

TimeoutInSeconds -> (integer)

The run timeout, in seconds, for the script.

CreatedTime -> (timestamp)

The created time of the app block.