class Amazonite::ApiGateway::CreateApiKeyRequest

Overview

Request to create an ApiKey resource.

Included Modules

Defined in:

api_gateway/create_api_key_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String | Nil = nil, description : String | Nil = nil, enabled : Bool | Nil = nil, generate_distinct_id : Bool | Nil = nil, value : String | Nil = nil, stage_keys : Array(StageKey) | Nil = nil, customer_id : String | Nil = nil, tags : Hash(String, String) | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def customer_id : String | Nil #

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.


[View source]
def customer_id=(customer_id : String | Nil) #

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.


[View source]
def description : String | Nil #

The description of the ApiKey.


[View source]
def description=(description : String | Nil) #

The description of the ApiKey.


[View source]
def enabled : Bool | Nil #

Specifies whether the ApiKey can be used by callers.


[View source]
def enabled=(enabled : Bool | Nil) #

Specifies whether the ApiKey can be used by callers.


[View source]
def generate_distinct_id : Bool | Nil #

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.


[View source]
def generate_distinct_id=(generate_distinct_id : Bool | Nil) #

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String | Nil #

The name of the ApiKey.


[View source]
def name=(name : String | Nil) #

The name of the ApiKey.


[View source]
def stage_keys : Array(StageKey) | Nil #

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.


[View source]
def stage_keys=(stage_keys : Array(StageKey) | Nil) #

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.


[View source]
def tags : Hash(String, String) | Nil #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.


[View source]
def tags=(tags : Hash(String, String) | Nil) #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.


[View source]
def validate! : Nil #

[View source]
def value : String | Nil #

Specifies a value of the API key.


[View source]
def value=(value : String | Nil) #

Specifies a value of the API key.


[View source]