Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

put-environment-blueprint-configuration

Description

Writes the configuration for the specified environment blueprint in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  put-environment-blueprint-configuration
--domain-identifier <value>
--enabled-regions <value>
--environment-blueprint-identifier <value>
[--environment-role-permission-boundary <value>]
[--manage-access-role-arn <value>]
[--provisioning-configurations <value>]
[--provisioning-role-arn <value>]
[--regional-parameters <value>]
[--cli-input-json <value>]
[--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>]

Options

--domain-identifier (string)

The identifier of the Amazon DataZone domain.

--enabled-regions (list)

Specifies the enabled Amazon Web Services Regions.

(string)

Syntax:

"string" "string" ...

--environment-blueprint-identifier (string)

The identifier of the environment blueprint.

--environment-role-permission-boundary (string)

The environment role permissions boundary.

--manage-access-role-arn (string)

The ARN of the manage access role.

--provisioning-configurations (list)

The provisioning configuration of a blueprint.

(tagged union structure)

The provisioning configuration of the blueprint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: lakeFormationConfiguration.

lakeFormationConfiguration -> (structure)

The Lake Formation configuration of the Data Lake blueprint.

locationRegistrationExcludeS3Locations -> (list)

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

(string)

locationRegistrationRole -> (string)

The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

Shorthand Syntax:

lakeFormationConfiguration={locationRegistrationExcludeS3Locations=[string,string],locationRegistrationRole=string} ...

JSON Syntax:

[
  {
    "lakeFormationConfiguration": {
      "locationRegistrationExcludeS3Locations": ["string", ...],
      "locationRegistrationRole": "string"
    }
  }
  ...
]

--provisioning-role-arn (string)

The ARN of the provisioning role.

--regional-parameters (map)

The regional parameters in the environment blueprint.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=KeyName1=string,KeyName2=string,KeyName2=KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

createdAt -> (timestamp)

The timestamp of when the environment blueprint was created.

domainId -> (string)

The identifier of the Amazon DataZone domain.

enabledRegions -> (list)

Specifies the enabled Amazon Web Services Regions.

(string)

environmentBlueprintId -> (string)

The identifier of the environment blueprint.

environmentRolePermissionBoundary -> (string)

The environment role permissions boundary.

manageAccessRoleArn -> (string)

The ARN of the manage access role.

provisioningConfigurations -> (list)

The provisioning configuration of a blueprint.

(tagged union structure)

The provisioning configuration of the blueprint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: lakeFormationConfiguration.

lakeFormationConfiguration -> (structure)

The Lake Formation configuration of the Data Lake blueprint.

locationRegistrationExcludeS3Locations -> (list)

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

(string)

locationRegistrationRole -> (string)

The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

provisioningRoleArn -> (string)

The ARN of the provisioning role.

regionalParameters -> (map)

The regional parameters in the environment blueprint.

key -> (string)

value -> (map)

key -> (string)

value -> (string)

updatedAt -> (timestamp)

The timestamp of when the environment blueprint was updated.