Class: Aws::EC2::Types::DescribeClassicLinkInstancesRequest

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 DescribeClassicLinkInstancesRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  instance_ids: ["InstanceId"],
  max_results: 1,
  next_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


12738
12739
12740
12741
12742
12743
12744
12745
12746
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12738

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC to which the instance is linked.

    vpc-id - The ID of the VPC that the instance is linked to.

Returns:



12738
12739
12740
12741
12742
12743
12744
12745
12746
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12738

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idsArray<String>

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Returns:

  • (Array<String>)


12738
12739
12740
12741
12742
12743
12744
12745
12746
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12738

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

  • (Integer)


12738
12739
12740
12741
12742
12743
12744
12745
12746
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12738

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


12738
12739
12740
12741
12742
12743
12744
12745
12746
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12738

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end