Class: AWSCDK::AppSync::CfnAPIKeyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/cfn_api_key_props.rb

Overview

Properties for defining a CfnApiKey.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id:, description: nil, expires: nil) ⇒ CfnAPIKeyProps

Returns a new instance of CfnAPIKeyProps.

Parameters:

  • api_id (String) —

    Unique AWS AppSync GraphQL API ID for this API key.

  • description (String, nil) (defaults to: nil) —

    Unique description of your API key.

  • expires (Numeric, nil) (defaults to: nil) —

    The time after which the API key expires.



12
13
14
15
16
17
18
19
 
# File 'app_sync/cfn_api_key_props.rb', line 12

def initialize(api_id:, description: nil, expires: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @expires = expires
  Jsii::Type.check_type(@expires, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "expires") unless @expires.nil?
end

Instance Attribute Details

#api_id ⇒ String (readonly)

Unique AWS AppSync GraphQL API ID for this API key.

Returns:

  • (String)

See Also:



25
26
27
 
# File 'app_sync/cfn_api_key_props.rb', line 25

def api_id
  @api_id
end

#description ⇒ String? (readonly)

Unique description of your API key.

Returns:

  • (String, nil)

See Also:



30
31
32
 
# File 'app_sync/cfn_api_key_props.rb', line 30

def description
  @description
end

#expires ⇒ Numeric? (readonly)

The time after which the API key expires.

The date is represented as seconds since the epoch, rounded down to the nearest hour.

Returns:

  • (Numeric, nil)

See Also:



37
38
39
 
# File 'app_sync/cfn_api_key_props.rb', line 37

def expires
  @expires
end

Class Method Details

.jsii_properties ⇒ Object 



39
40
41
42
43
44
45
 
# File 'app_sync/cfn_api_key_props.rb', line 39

def self.jsii_properties
  {
    :api_id => "apiId",
    :description => "description",
    :expires => "expires",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'app_sync/cfn_api_key_props.rb', line 47

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "description" => @description,
    "expires" => @expires,
  })
  result.compact
end