Class: Aws::AppSync::Types::Api

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

Overview

Describes an AppSync API. You can use Api for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_arn ⇒ String

The Amazon Resource Name (ARN) for the Api.

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The Api ID.

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#created ⇒ Time

The date and time that the Api was created.

Returns:

  • (Time) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#dns ⇒ Hash<String,String>

The DNS records for the API. This will include an HTTP and a real-time endpoint.

Returns:

  • (Hash<String,String>) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#event_config ⇒ Types::EventConfig

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the Api.

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#owner_contact ⇒ String

The owner contact information for the Api

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map with keys of TagKey objects and values of TagValue objects.

Returns:

  • (Hash<String,String>) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#waf_web_acl_arn ⇒ String

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end

#xray_enabled ⇒ Boolean

A flag indicating whether to use X-Ray tracing for this Api.

Returns:

  • (Boolean) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 108

class Api < Struct.new(
  :api_id,
  :name,
  :owner_contact,
  :tags,
  :dns,
  :api_arn,
  :created,
  :xray_enabled,
  :waf_web_acl_arn,
  :event_config)
  SENSITIVE = []
  include Aws::Structure
end