Class: Aws::EC2::Types::CreateIpamScopeRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateIpamScopeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  A description for the scope you’re creating.

• #dry_run ⇒ Boolean

  A check for whether you have the required permissions for the action without actually making the request and provides an error response.

• #ipam_id ⇒ String

  The ID of the IPAM for which you’re creating this scope.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The key/value combination of a tag assigned to the resource.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

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

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 9951

class CreateIpamScopeRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the scope you’re creating.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 9951

class CreateIpamScopeRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

A check for 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)

# File 'lib/aws-sdk-ec2/types.rb', line 9951

class CreateIpamScopeRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_id ⇒ String

The ID of the IPAM for which you’re creating this scope.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 9951

class CreateIpamScopeRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

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.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 9951

class CreateIpamScopeRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :description,
  :tag_specifications,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end