Package software.amazon.awscdk.services.appsync

Class CfnSourceApiAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appsync.CfnSourceApiAssociation

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.158Z")
@Stability(Stable)
public class CfnSourceApiAssociation
extends CfnResource
implements IInspectable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSourceApiAssociation.Builder	A fluent builder for CfnSourceApiAssociation.
static interface	CfnSourceApiAssociation.SourceApiAssociationConfigProperty	Describes properties used to specify configurations related to a source API.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSourceApiAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSourceApiAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSourceApiAssociation(software.constructs.Construct scope, String id)
	CfnSourceApiAssociation(software.constructs.Construct scope, String id, CfnSourceApiAssociationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAssociationArn()	The Amazon Resource Name (ARN) of the source API association.
String	getAttrAssociationId()	The ID generated by the AppSync service for the source API association.
String	getAttrLastSuccessfulMergeDate()	The datetime value of the last successful merge of the source API association.
String	getAttrMergedApiArn()	The Amazon Resource Name (ARN) of the merged API.
String	getAttrMergedApiId()	The ID of the merged API.
String	getAttrSourceApiArn()	The source API's Amazon Resource Name (ARN) value.
String	getAttrSourceApiAssociationStatus()	The state of the source API association.
String	getAttrSourceApiAssociationStatusDetail()	The message describing the state of the source API association.
String	getAttrSourceApiId()	The ID of the source API.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description field of the association configuration.
String	getMergedApiIdentifier()	The identifier of the AppSync Merged API.
Object	getSourceApiAssociationConfig()	The SourceApiAssociationConfig object data.
String	getSourceApiIdentifier()	The identifier of the AppSync Source API.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description field of the association configuration.
void	setMergedApiIdentifier(String value)	The identifier of the AppSync Merged API.
void	setSourceApiAssociationConfig(IResolvable value)	The SourceApiAssociationConfig object data.
void	setSourceApiAssociationConfig(CfnSourceApiAssociation.SourceApiAssociationConfigProperty value)	The SourceApiAssociationConfig object data.
void	setSourceApiIdentifier(String value)	The identifier of the AppSync Source API.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnSourceApiAssociationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnSourceApiAssociation

@Stability(Stable)
public CfnSourceApiAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

setMergedApiIdentifier

@Stability(Stable)
public void setMergedApiIdentifier(@Nullable
 String value)

The identifier of the AppSync 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.

setSourceApiIdentifier

@Stability(Stable)
public void setSourceApiIdentifier(@Nullable
 String value)

The identifier of the AppSync Source API.