Class: Aws::EC2::Types::CreateManagedPrefixListRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateManagedPrefixListRequest data as a hash:

{
  dry_run: false,
  prefix_list_name: "String", # required
  entries: [
    {
      cidr: "String", # required
      description: "String",
    },
  ],
  max_entries: 1, # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  address_family: "String", # required
  client_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The IP address type.

Valid Values: IPv4 | IPv6

Returns:

  • (String)


9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#entriesArray<Types::AddPrefixListEntry>

One or more entries for the prefix list.

Returns:



9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_entriesInteger

The maximum number of entries for the prefix list.

Returns:

  • (Integer)


9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#prefix_list_nameString

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

Returns:

  • (String)


9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the prefix list during creation.

Returns:



9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9002

class CreateManagedPrefixListRequest < Struct.new(
  :dry_run,
  :prefix_list_name,
  :entries,
  :max_entries,
  :tag_specifications,
  :address_family,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end