[ aws . continuum ]

create-environment

Description

Creates an environment and starts its validation and any requested provisioning. Storage provisioning and dependency checks may continue after the initial 201 response; use GetEnvironment to observe completion.

See also: AWS API Documentation

Synopsis

  create-environment
--name <value>
[--configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--name (string) [required]

The customer-visible name of the environment.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9 _.\-]{0,254}

--configuration (structure)

Type-specific configuration. Omission creates a code environment with the default operating policy and no sources.

codeConfiguration -> (structure)

Configuration for a code-scanning environment.

sourceConfiguration -> (structure)

Source configuration for the environment.

s3Sources -> (list)

S3 sources backed by previously-created S3 integrations.

Constraints:

  • min: 1
  • max: 1

(structure)

An S3 source for one environment, backed by a previously-created S3 integration.

integrationId -> (string) [required]

Identifier of an S3 integration in the caller’s account. The integration supplies the bucket, the read role, and the external ID Continuum uses to read the prefixes.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

codePrefix -> (string)

Prefix containing source code. Defaults to code/ when omitted.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*/

contextPrefix -> (string)

Prefix containing customer-authored context. Defaults to context/ when omitted.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*/

repositorySources -> (list)

Explicit repository selections from previously-created integrations.

Constraints:

  • min: 1
  • max: 100

(structure)

One repository selected from a previously-created integration.

integrationId -> (string) [required]

Integration that provides the selected repository.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

repository -> (string) [required]

Repository selected from that integration in owner/repository form.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9_\-\.]+/[a-zA-Z0-9_\-\.]+

defaultBranch -> (string)

Branch used when a scan does not choose a more specific revision.

Constraints:

  • min: 1
  • max: 255

environmentConfiguration -> (structure)

Environment-level operating policy.

network -> (structure)

Network policy for agent execution.

allowedDomains -> (list)

Domains that an environment’s agent execution may contact.

Constraints:

  • min: 1
  • max: 50

(string)

A domain name permitted for build-time dependency resolution.

Constraints:

  • min: 1
  • max: 253
  • pattern: ([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}

scanFrequency -> (string)

Recurring scan interval: P1D (1 day), P2D (2 days), or P7D (7 days). PT0H disables recurring scans. Defaults to P1D when creating an environment.

Constraints:

  • min: 3
  • max: 64
  • pattern: P([0-9]+Y([0-9]+M)?([0-9]+D)?(T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S))?|[0-9]+M([0-9]+D)?(T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S))?|[0-9]+D(T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S))?|T([0-9]+H([0-9]+M)?([0-9]+S)?|[0-9]+M([0-9]+S)?|[0-9]+S))

patchCreationPolicy -> (string)

Whether Continuum creates a patch for a proposed remediation. Defaults to DISABLED.

Possible values:

  • ENABLED
  • DISABLED

JSON Syntax:

{
  "codeConfiguration": {
    "sourceConfiguration": {
      "s3Sources": [
        {
          "integrationId": "string",
          "codePrefix": "string",
          "contextPrefix": "string"
        }
        ...
      ],
      "repositorySources": [
        {
          "integrationId": "string",
          "repository": "string",
          "defaultBranch": "string"
        }
        ...
      ]
    },
    "environmentConfiguration": {
      "network": {
        "allowedDomains": ["string", ...]
      },
      "scanFrequency": "string",
      "patchCreationPolicy": "ENABLED"|"DISABLED"
    }
  }
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

environmentId -> (string)

The unique identifier assigned to the environment.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

environmentArn -> (string)

The ARN of the created environment.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:continuum:[a-z0-9-]+:[0-9]{12}:environments/[a-z0-9]+

status -> (string)

The initial status of the environment. Always ACTIVE on successful creation.

Possible values:

  • ACTIVE

createdAt -> (timestamp)

The timestamp when the environment was created.