AWS CLI Command Reference

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 . emr-containers ]

describe-security-configuration

Description

Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

See also: AWS API Documentation

Synopsis

  describe-security-configuration
--id <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

--id (string)

The ID of the security configuration.

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

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

securityConfiguration -> (structure)

Details of the security configuration.

id -> (string)

The ID of the security configuration.

name -> (string)

The name of the security configuration.

arn -> (string)

The ARN (Amazon Resource Name) of the security configuration.

createdAt -> (timestamp)

The date and time that the job run was created.

createdBy -> (string)

The user who created the job run.

securityConfigurationData -> (structure)

Security configuration inputs for the request.

authorizationConfiguration -> (structure)

Authorization-related configuration input for the security configuration.

lakeFormationConfiguration -> (structure)

Lake Formation related configuration inputs for the security configuration.

authorizedSessionTagValue -> (string)

The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

secureNamespaceInfo -> (structure)

The namespace input of the system job.

clusterId -> (string)

The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

namespace -> (string)

The namespace of the Amazon EKS cluster where the system jobs run.

queryEngineRoleArn -> (string)

The query engine IAM role ARN that is tied to the secure Spark job. The QueryEngine role assumes the JobExecutionRole to execute all the Lake Formation calls.

encryptionConfiguration -> (structure)

Encryption-related configuration input for the security configuration.

inTransitEncryptionConfiguration -> (structure)

In-transit encryption-related input for the security configuration.

tlsCertificateConfiguration -> (structure)

TLS certificate-related configuration input for the security configuration.

certificateProviderType -> (string)

The TLS certificate type. Acceptable values: PEM or Custom .

publicCertificateSecretArn -> (string)

Secrets Manager ARN that contains the public TLS certificate contents, used for communication between the user job and the system job.

privateCertificateSecretArn -> (string)

Secrets Manager ARN that contains the private TLS certificate contents, used for communication between the user job and the system job.

tags -> (map)

The tags to assign to the security configuration.

key -> (string)

value -> (string)