[ aws . emr-containers ]

create-managed-endpoint

Description

Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-managed-endpoint
--name <value>
--virtual-cluster-id <value>
--type <value>
--release-label <value>
--execution-role-arn <value>
[--certificate-arn <value>]
[--configuration-overrides <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the managed endpoint.

--virtual-cluster-id (string)

The ID of the virtual cluster for which a managed endpoint is created.

--type (string)

The type of the managed endpoint.

--release-label (string)

The Amazon EMR release version.

--execution-role-arn (string)

The ARN of the execution role.

--certificate-arn (string)

The certificate ARN provided by users for the managed endpoint. This fiedd is under deprecation and will be removed in future releases.

--configuration-overrides (structure)

The configuration settings that will be used to override existing configurations.

applicationConfiguration -> (list)

The configurations for the application running by the job run.

(structure)

A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

classification -> (string)

The classification within a configuration.

properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

configurations -> (list)

A list of additional configurations to apply within a configuration object.

(structure)

A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

classification -> (string)

The classification within a configuration.

properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

monitoringConfiguration -> (structure)

The configurations for monitoring.

persistentAppUI -> (string)

Monitoring configurations for the persistent application UI.

cloudWatchMonitoringConfiguration -> (structure)

Monitoring configurations for CloudWatch.

logGroupName -> (string)

The name of the log group for log publishing.

logStreamNamePrefix -> (string)

The specified name prefix for log streams.

s3MonitoringConfiguration -> (structure)

Amazon S3 configuration for monitoring log publishing.

logUri -> (string)

Amazon S3 destination URI for log publishing.

Shorthand Syntax:

applicationConfiguration=[{classification=string,properties={KeyName1=string,KeyName2=string},( ... recursive ... )},{classification=string,properties={KeyName1=string,KeyName2=string},( ... recursive ... )}],monitoringConfiguration={persistentAppUI=string,cloudWatchMonitoringConfiguration={logGroupName=string,logStreamNamePrefix=string},s3MonitoringConfiguration={logUri=string}}

JSON Syntax:

{
  "applicationConfiguration": [
    {
      "classification": "string",
      "properties": {"string": "string"
        ...},
      "configurations": [
        {
          "classification": "string",
          "properties": {"string": "string"
            ...},
          "configurations":
        }
        ...
      ]
    }
    ...
  ],
  "monitoringConfiguration": {
    "persistentAppUI": "ENABLED"|"DISABLED",
    "cloudWatchMonitoringConfiguration": {
      "logGroupName": "string",
      "logStreamNamePrefix": "string"
    },
    "s3MonitoringConfiguration": {
      "logUri": "string"
    }
  }
}

--client-token (string)

The client idempotency token for this create call.

--tags (map)

The tags of the managed endpoint.

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

See ‘aws help’ for descriptions of global parameters.

Output

id -> (string)

The output contains the ID of the managed endpoint.

name -> (string)

The output contains the name of the managed endpoint.

arn -> (string)

The output contains the ARN of the managed endpoint.

virtualClusterId -> (string)

The output contains the ID of the virtual cluster.