Package software.amazon.awscdk.services.appsync

Interface CfnSourceApiAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSourceApiAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:11.415Z")
@Stability(Stable)
public interface CfnSourceApiAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSourceApiAssociation.

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.*;
 CfnSourceApiAssociationProps cfnSourceApiAssociationProps = CfnSourceApiAssociationProps.builder()
         .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	Interface	Description
static final class	CfnSourceApiAssociationProps.Builder	A builder for CfnSourceApiAssociationProps
static final class	CfnSourceApiAssociationProps.Jsii$Proxy	An implementation for CfnSourceApiAssociationProps

Method Summary

Modifier and Type	Method	Description
static CfnSourceApiAssociationProps.Builder	builder()
default String	getDescription()	The description field of the association configuration.
default String	getMergedApiIdentifier()	The identifier of the AppSync Merged API.
default Object	getSourceApiAssociationConfig()	The SourceApiAssociationConfig object data.
default String	getSourceApiIdentifier()	The identifier of the AppSync Source API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description field of the association configuration.

See Also:

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

getMergedApiIdentifier

@Stability(Stable)
@Nullable
default 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.

See Also:

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

getSourceApiAssociationConfig

@Stability(Stable)
@Nullable
default Object getSourceApiAssociationConfig()

The SourceApiAssociationConfig object data.

See Also:

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

getSourceApiIdentifier

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

@Stability(Stable)
static CfnSourceApiAssociationProps.Builder builder()

Returns:

a CfnSourceApiAssociationProps.Builder of CfnSourceApiAssociationProps