[ aws . fms ]

put-apps-list

Description

Creates an AWS Firewall Manager applications list.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-apps-list
--apps-list <value>
[--tag-list <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--apps-list (structure)

The details of the AWS Firewall Manager applications list to be created.

ListId -> (string)

The ID of the AWS Firewall Manager applications list.

ListName -> (string)

The name of the AWS Firewall Manager applications list.

ListUpdateToken -> (string)

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

CreateTime -> (timestamp)

The time that the AWS Firewall Manager applications list was created.

LastUpdateTime -> (timestamp)

The time that the AWS Firewall Manager applications list was last updated.

AppsList -> (list)

An array of applications in the AWS Firewall Manager applications list.

(structure)

An individual AWS Firewall Manager application.

AppName -> (string)

The application’s name.

Protocol -> (string)

The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .

Port -> (long)

The application’s port number, for example 80 .

PreviousAppsList -> (map)

A map of previous version numbers to their corresponding App object arrays.

key -> (string)

value -> (list)

(structure)

An individual AWS Firewall Manager application.

AppName -> (string)

The application’s name.

Protocol -> (string)

The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .

Port -> (long)

The application’s port number, for example 80 .

Shorthand Syntax:

ListId=string,ListName=string,ListUpdateToken=string,CreateTime=timestamp,LastUpdateTime=timestamp,AppsList=[{AppName=string,Protocol=string,Port=long},{AppName=string,Protocol=string,Port=long}],PreviousAppsList={KeyName1=[{AppName=string,Protocol=string,Port=long},{AppName=string,Protocol=string,Port=long}],KeyName2=[{AppName=string,Protocol=string,Port=long},{AppName=string,Protocol=string,Port=long}]}

JSON Syntax:

{
  "ListId": "string",
  "ListName": "string",
  "ListUpdateToken": "string",
  "CreateTime": timestamp,
  "LastUpdateTime": timestamp,
  "AppsList": [
    {
      "AppName": "string",
      "Protocol": "string",
      "Port": long
    }
    ...
  ],
  "PreviousAppsList": {"string": [
        {
          "AppName": "string",
          "Protocol": "string",
          "Port": long
        }
        ...
      ]
    ...}
}

--tag-list (list)

The tags associated with the resource.

(structure)

A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each AWS resource.

Key -> (string)

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

Value -> (string)

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

AppsList -> (structure)

The details of the AWS Firewall Manager applications list.

ListId -> (string)

The ID of the AWS Firewall Manager applications list.

ListName -> (string)

The name of the AWS Firewall Manager applications list.

ListUpdateToken -> (string)

A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

CreateTime -> (timestamp)

The time that the AWS Firewall Manager applications list was created.

LastUpdateTime -> (timestamp)

The time that the AWS Firewall Manager applications list was last updated.

AppsList -> (list)

An array of applications in the AWS Firewall Manager applications list.

(structure)

An individual AWS Firewall Manager application.

AppName -> (string)

The application’s name.

Protocol -> (string)

The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .

Port -> (long)

The application’s port number, for example 80 .

PreviousAppsList -> (map)

A map of previous version numbers to their corresponding App object arrays.

key -> (string)

value -> (list)

(structure)

An individual AWS Firewall Manager application.

AppName -> (string)

The application’s name.

Protocol -> (string)

The IP protocol name or number. The name can be one of tcp , udp , or icmp . For information on possible numbers, see Protocol Numbers .

Port -> (long)

The application’s port number, for example 80 .

AppsListArn -> (string)

The Amazon Resource Name (ARN) of the applications list.