[ aws . elbv2 ]

describe-ssl-policies

Description

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-ssl-policies is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: SslPolicies

Synopsis

  describe-ssl-policies
[--names <value>]
[--page-size <value>]
[--load-balancer-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--names (list)

The names of the policies.

(string)

Syntax:

"string" "string" ...

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--load-balancer-type (string)

The type of load balancer. The default lists the SSL policies for all load balancers.

Possible values:

• application

• network

• gateway

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe a policy used for SSL negotiation

The following describe-ssl-policies example displays details of the specified policy used for SSL negotiation.

aws elbv2 describe-ssl-policies \
    --names ELBSecurityPolicy-2016-08

Output:

{
    "SslPolicies": [
        {
            "SslProtocols": [
                "TLSv1",
                "TLSv1.1",
                "TLSv1.2"
            ],
            "Ciphers": [
                {
                    "Priority": 1,
                    "Name": "ECDHE-ECDSA-AES128-GCM-SHA256"
                },
                {
                    "Priority": 2,
                    "Name": "ECDHE-RSA-AES128-GCM-SHA256"
                },
                {
                    "Priority": 3,
                    "Name": "ECDHE-ECDSA-AES128-SHA256"
                },

                ...some output truncated...

                {
                    "Priority": 18,
                    "Name": "AES256-SHA"
                }
            ],
            "Name": "ELBSecurityPolicy-2016-08"
        }
    ]
}

To describe all policies used for SSL negotiation

The following describe-ssl-policies example displays details for all the policies that you can use for SSL negotiation.

aws elbv2 describe-ssl-policies

Output

SslPolicies -> (list)

Information about the security policies.

(structure)

Information about a policy used for SSL negotiation.

SslProtocols -> (list)

The protocols.

(string)

Ciphers -> (list)

The ciphers.

(structure)

Information about a cipher used in a policy.

Name -> (string)

The name of the cipher.

Priority -> (integer)

The priority of the cipher.

Name -> (string)

The name of the policy.

SupportedLoadBalancerTypes -> (list)

The supported load balancers.

(string)

NextMarker -> (string)

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.