Package software.amazon.awscdk.services.appsync

Class CfnSourceApiAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appsync.CfnSourceApiAssociation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.480Z") @Stability(Stable) public class CfnSourceApiAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::AppSync::SourceApiAssociation.

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 Resource Access Manager.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnSourceApiAssociation cfnSourceApiAssociation = CfnSourceApiAssociation.Builder.create(this, "MyCfnSourceApiAssociation")
         .description("description")
         .mergedApiIdentifier("mergedApiIdentifier")
         .sourceApiAssociationConfig(SourceApiAssociationConfigProperty.builder()
                 .mergeType("mergeType")
                 .build())
         .sourceApiIdentifier("sourceApiIdentifier")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSourceApiAssociation

      protected CfnSourceApiAssociation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSourceApiAssociation

      protected CfnSourceApiAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSourceApiAssociation

      @Stability(Stable) public CfnSourceApiAssociation(@NotNull Construct scope, @NotNull String id, @Nullable CfnSourceApiAssociationProps props)
      Create a new AWS::AppSync::SourceApiAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnSourceApiAssociation

      @Stability(Stable) public CfnSourceApiAssociation(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::AppSync::SourceApiAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAssociationArn

      @Stability(Stable) @NotNull public String getAttrAssociationArn()
      The Amazon Resource Name (ARN) of the source API association.

    • getAttrAssociationId

      @Stability(Stable) @NotNull public String getAttrAssociationId()
      The ID generated by the AppSync service for the source API association.

    • getAttrLastSuccessfulMergeDate

      @Stability(Stable) @NotNull public String getAttrLastSuccessfulMergeDate()
      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.

    • getAttrMergedApiArn

      @Stability(Stable) @NotNull public String getAttrMergedApiArn()
      The Amazon Resource Name (ARN) of the merged API.

    • getAttrMergedApiId

      @Stability(Stable) @NotNull public String getAttrMergedApiId()
      The ID of the merged API.

    • getAttrSourceApiArn

      @Stability(Stable) @NotNull public String getAttrSourceApiArn()
      The source API's Amazon Resource Name (ARN) value.

    • getAttrSourceApiAssociationStatus

      @Stability(Stable) @NotNull public String getAttrSourceApiAssociationStatus()
      The state of the source API association.

      The following values are valid:

      MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILED

    • getAttrSourceApiAssociationStatusDetail

      @Stability(Stable) @NotNull public String getAttrSourceApiAssociationStatusDetail()
      The message describing the state of the source API association.

    • getAttrSourceApiId

      @Stability(Stable) @NotNull public String getAttrSourceApiId()
      The ID of the source API.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description field of the association configuration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description field of the association configuration.

    • getMergedApiIdentifier

      @Stability(Stable) @Nullable public String getMergedApiIdentifier()
      The identifier of the AppSync Merged API.

      This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    • setMergedApiIdentifier

      @Stability(Stable) public void setMergedApiIdentifier(@Nullable String value)
      The identifier of the AppSync Merged API.

      This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

    • getSourceApiAssociationConfig

      @Stability(Stable) @Nullable public Object getSourceApiAssociationConfig()
      The SourceApiAssociationConfig object data.

    • setSourceApiAssociationConfig

      @Stability(Stable) public void setSourceApiAssociationConfig(@Nullable IResolvable value)
      The SourceApiAssociationConfig object data.

    • setSourceApiAssociationConfig

      @Stability(Stable) public void setSourceApiAssociationConfig(@Nullable CfnSourceApiAssociation.SourceApiAssociationConfigProperty value)
      The SourceApiAssociationConfig object data.

    • getSourceApiIdentifier

      @Stability(Stable) @Nullable public String getSourceApiIdentifier()
      The identifier of the AppSync Source API.

      This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

    • setSourceApiIdentifier

      @Stability(Stable) public void setSourceApiIdentifier(@Nullable String value)
      The identifier of the AppSync Source API.

      This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.