Class: Aws::AppSync::Types::SourceApiAssociation

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

Overview

Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API’s schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API.

Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see [What is Amazon Web Services Resource Access Manager?] in the *Amazon Web Services Resource Access Manager* guide.

[1]: docs.aws.amazon.com/ram/latest/userguide/what-is.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#association_arn ⇒ String

The Amazon Resource Name (ARN) of the source API association.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#association_id ⇒ String

The ID generated by the AppSync service for the source API association.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description field.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_successful_merge_date ⇒ Time

The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

Returns:

  • (Time) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#merged_api_arn ⇒ String

The Amazon Resource Name (ARN) of the AppSync Merged API.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#merged_api_id ⇒ String

The ID of the AppSync Merged API.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#source_api_arn ⇒ String

The Amazon Resource Name (ARN) of the AppSync source API.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#source_api_association_config ⇒ Types::SourceApiAssociationConfig

The ‘SourceApiAssociationConfig` object data.

Returns:



4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#source_api_association_status ⇒ String

The state of the source API association.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#source_api_association_status_detail ⇒ String

The detailed message related to the current state of the source API association.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end

#source_api_id ⇒ String

The ID of the AppSync source API.

Returns:

  • (String) 


4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
 
# File 'lib/aws-sdk-appsync/types.rb', line 4608

class SourceApiAssociation < Struct.new(
  :association_id,
  :association_arn,
  :source_api_id,
  :source_api_arn,
  :merged_api_arn,
  :merged_api_id,
  :description,
  :source_api_association_config,
  :source_api_association_status,
  :source_api_association_status_detail,
  :last_successful_merge_date)
  SENSITIVE = []
  include Aws::Structure
end