software.amazon.awscdk.services.appsync

Class CfnDataSource

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.CfnDataSource

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.096Z")
 @Stability(value=Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::DataSource`.

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.*;
 CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
         .apiId("apiId")
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .dynamoDbConfig(DynamoDBConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .tableName("tableName")
                 // the properties below are optional
                 .deltaSyncConfig(DeltaSyncConfigProperty.builder()
                         .baseTableTtl("baseTableTtl")
                         .deltaSyncTableName("deltaSyncTableName")
                         .deltaSyncTableTtl("deltaSyncTableTtl")
                         .build())
                 .useCallerCredentials(false)
                 .versioned(false)
                 .build())
         .elasticsearchConfig(ElasticsearchConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .httpConfig(HttpConfigProperty.builder()
                 .endpoint("endpoint")
                 // the properties below are optional
                 .authorizationConfig(AuthorizationConfigProperty.builder()
                         .authorizationType("authorizationType")
                         // the properties below are optional
                         .awsIamConfig(AwsIamConfigProperty.builder()
                                 .signingRegion("signingRegion")
                                 .signingServiceName("signingServiceName")
                                 .build())
                         .build())
                 .build())
         .lambdaConfig(LambdaConfigProperty.builder()
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .build())
         .openSearchServiceConfig(OpenSearchServiceConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .endpoint("endpoint")
                 .build())
         .relationalDatabaseConfig(RelationalDatabaseConfigProperty.builder()
                 .relationalDatabaseSourceType("relationalDatabaseSourceType")
                 // the properties below are optional
                 .rdsHttpEndpointConfig(RdsHttpEndpointConfigProperty.builder()
                         .awsRegion("awsRegion")
                         .awsSecretStoreArn("awsSecretStoreArn")
                         .dbClusterIdentifier("dbClusterIdentifier")
                         // the properties below are optional
                         .databaseName("databaseName")
                         .schema("schema")
                         .build())
                 .build())
         .serviceRoleArn("serviceRoleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDataSource.AuthorizationConfigProperty Example:
static interface	CfnDataSource.AwsIamConfigProperty Example:
static class	CfnDataSource.Builder A fluent builder for CfnDataSource.
static interface	CfnDataSource.DeltaSyncConfigProperty Example:
static interface	CfnDataSource.DynamoDBConfigProperty Example:
static interface	CfnDataSource.ElasticsearchConfigProperty Example:
static interface	CfnDataSource.HttpConfigProperty Example:
static interface	CfnDataSource.LambdaConfigProperty Example:
static interface	CfnDataSource.OpenSearchServiceConfigProperty Example:
static interface	CfnDataSource.RdsHttpEndpointConfigProperty Example:
static interface	CfnDataSource.RelationalDatabaseConfigProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataSource(software.constructs.Construct scope, String id, CfnDataSourceProps props) Create a new `AWS::AppSync::DataSource`.
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApiId() `AWS::AppSync::DataSource.ApiId`.
String	getAttrDataSourceArn()
String	getAttrName()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::AppSync::DataSource.Description`.
Object	getDynamoDbConfig() `AWS::AppSync::DataSource.DynamoDBConfig`.
Object	getElasticsearchConfig() `AWS::AppSync::DataSource.ElasticsearchConfig`.
Object	getHttpConfig() `AWS::AppSync::DataSource.HttpConfig`.
Object	getLambdaConfig() `AWS::AppSync::DataSource.LambdaConfig`.
String	getName() `AWS::AppSync::DataSource.Name`.
Object	getOpenSearchServiceConfig() `AWS::AppSync::DataSource.OpenSearchServiceConfig`.
Object	getRelationalDatabaseConfig() `AWS::AppSync::DataSource.RelationalDatabaseConfig`.
String	getServiceRoleArn() `AWS::AppSync::DataSource.ServiceRoleArn`.
String	getType() `AWS::AppSync::DataSource.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value) `AWS::AppSync::DataSource.ApiId`.
void	setDescription(String value) `AWS::AppSync::DataSource.Description`.
void	setDynamoDbConfig(CfnDataSource.DynamoDBConfigProperty value) `AWS::AppSync::DataSource.DynamoDBConfig`.
void	setDynamoDbConfig(IResolvable value) `AWS::AppSync::DataSource.DynamoDBConfig`.
void	setElasticsearchConfig(CfnDataSource.ElasticsearchConfigProperty value) `AWS::AppSync::DataSource.ElasticsearchConfig`.
void	setElasticsearchConfig(IResolvable value) `AWS::AppSync::DataSource.ElasticsearchConfig`.
void	setHttpConfig(CfnDataSource.HttpConfigProperty value) `AWS::AppSync::DataSource.HttpConfig`.
void	setHttpConfig(IResolvable value) `AWS::AppSync::DataSource.HttpConfig`.
void	setLambdaConfig(CfnDataSource.LambdaConfigProperty value) `AWS::AppSync::DataSource.LambdaConfig`.
void	setLambdaConfig(IResolvable value) `AWS::AppSync::DataSource.LambdaConfig`.
void	setName(String value) `AWS::AppSync::DataSource.Name`.
void	setOpenSearchServiceConfig(CfnDataSource.OpenSearchServiceConfigProperty value) `AWS::AppSync::DataSource.OpenSearchServiceConfig`.
void	setOpenSearchServiceConfig(IResolvable value) `AWS::AppSync::DataSource.OpenSearchServiceConfig`.
void	setRelationalDatabaseConfig(CfnDataSource.RelationalDatabaseConfigProperty value) `AWS::AppSync::DataSource.RelationalDatabaseConfig`.
void	setRelationalDatabaseConfig(IResolvable value) `AWS::AppSync::DataSource.RelationalDatabaseConfig`.
void	setServiceRoleArn(String value) `AWS::AppSync::DataSource.ServiceRoleArn`.
void	setType(String value) `AWS::AppSync::DataSource.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataSource

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

CfnDataSource

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

CfnDataSource

@Stability(value=Stable)
public CfnDataSource(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnDataSourceProps props)

Create a new `AWS::AppSync::DataSource`.

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. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

`AWS::AppSync::DataSource.ApiId`.

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

`AWS::AppSync::DataSource.ApiId`.

getAttrDataSourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrDataSourceArn()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::AppSync::DataSource.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::AppSync::DataSource.Description`.

getDynamoDbConfig

@Stability(value=Stable)
 @Nullable
public Object getDynamoDbConfig()

`AWS::AppSync::DataSource.DynamoDBConfig`.

setDynamoDbConfig

@Stability(value=Stable)
public void setDynamoDbConfig(@Nullable
                                                       CfnDataSource.DynamoDBConfigProperty value)

`AWS::AppSync::DataSource.DynamoDBConfig`.

setDynamoDbConfig

@Stability(value=Stable)
public void setDynamoDbConfig(@Nullable
                                                       IResolvable value)

`AWS::AppSync::DataSource.DynamoDBConfig`.

getElasticsearchConfig

@Stability(value=Stable)
 @Nullable
public Object getElasticsearchConfig()

`AWS::AppSync::DataSource.ElasticsearchConfig`.

setElasticsearchConfig

@Stability(value=Stable)
public void setElasticsearchConfig(@Nullable
                                                            CfnDataSource.ElasticsearchConfigProperty value)

`AWS::AppSync::DataSource.ElasticsearchConfig`.

setElasticsearchConfig

@Stability(value=Stable)
public void setElasticsearchConfig(@Nullable
                                                            IResolvable value)

`AWS::AppSync::DataSource.ElasticsearchConfig`.

getHttpConfig

@Stability(value=Stable)
 @Nullable
public Object getHttpConfig()

`AWS::AppSync::DataSource.HttpConfig`.

setHttpConfig

@Stability(value=Stable)
public void setHttpConfig(@Nullable
                                                   CfnDataSource.HttpConfigProperty value)

`AWS::AppSync::DataSource.HttpConfig`.

setHttpConfig

@Stability(value=Stable)
public void setHttpConfig(@Nullable
                                                   IResolvable value)

`AWS::AppSync::DataSource.HttpConfig`.

getLambdaConfig

@Stability(value=Stable)
 @Nullable
public Object getLambdaConfig()

`AWS::AppSync::DataSource.LambdaConfig`.

setLambdaConfig

@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     CfnDataSource.LambdaConfigProperty value)

`AWS::AppSync::DataSource.LambdaConfig`.

setLambdaConfig

@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     IResolvable value)

`AWS::AppSync::DataSource.LambdaConfig`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::AppSync::DataSource.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::AppSync::DataSource.Name`.

getOpenSearchServiceConfig

@Stability(value=Stable)
 @Nullable
public Object getOpenSearchServiceConfig()

`AWS::AppSync::DataSource.OpenSearchServiceConfig`.

setOpenSearchServiceConfig

@Stability(value=Stable)
public void setOpenSearchServiceConfig(@Nullable
                                                                CfnDataSource.OpenSearchServiceConfigProperty value)

`AWS::AppSync::DataSource.OpenSearchServiceConfig`.

setOpenSearchServiceConfig

@Stability(value=Stable)
public void setOpenSearchServiceConfig(@Nullable
                                                                IResolvable value)

`AWS::AppSync::DataSource.OpenSearchServiceConfig`.

getRelationalDatabaseConfig

@Stability(value=Stable)
 @Nullable
public Object getRelationalDatabaseConfig()

`AWS::AppSync::DataSource.RelationalDatabaseConfig`.

setRelationalDatabaseConfig

@Stability(value=Stable)
public void setRelationalDatabaseConfig(@Nullable
                                                                 CfnDataSource.RelationalDatabaseConfigProperty value)

`AWS::AppSync::DataSource.RelationalDatabaseConfig`.

setRelationalDatabaseConfig

@Stability(value=Stable)
public void setRelationalDatabaseConfig(@Nullable
                                                                 IResolvable value)

`AWS::AppSync::DataSource.RelationalDatabaseConfig`.

getServiceRoleArn

@Stability(value=Stable)
 @Nullable
public String getServiceRoleArn()

`AWS::AppSync::DataSource.ServiceRoleArn`.

setServiceRoleArn

@Stability(value=Stable)
public void setServiceRoleArn(@Nullable
                                                       String value)

`AWS::AppSync::DataSource.ServiceRoleArn`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::AppSync::DataSource.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::AppSync::DataSource.Type`.