Class CfnDataSourceMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.appsync.CfnDataSourceMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSourceMixinProps>
- Enclosing interface:
CfnDataSourceMixinProps
@Stability(Stable)
public static final class CfnDataSourceMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSourceMixinProps>
A builder for
CfnDataSourceMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnDataSourceMixinProps.getApiId()build()Builds the configured instance.description(String description) Sets the value ofCfnDataSourceMixinProps.getDescription()dynamoDbConfig(CfnDataSourcePropsMixin.DynamoDBConfigProperty dynamoDbConfig) Sets the value ofCfnDataSourceMixinProps.getDynamoDbConfig()dynamoDbConfig(IResolvable dynamoDbConfig) Sets the value ofCfnDataSourceMixinProps.getDynamoDbConfig()elasticsearchConfig(CfnDataSourcePropsMixin.ElasticsearchConfigProperty elasticsearchConfig) Deprecated.this property has been deprecatedelasticsearchConfig(IResolvable elasticsearchConfig) Deprecated.this property has been deprecatedeventBridgeConfig(CfnDataSourcePropsMixin.EventBridgeConfigProperty eventBridgeConfig) Sets the value ofCfnDataSourceMixinProps.getEventBridgeConfig()eventBridgeConfig(IResolvable eventBridgeConfig) Sets the value ofCfnDataSourceMixinProps.getEventBridgeConfig()httpConfig(CfnDataSourcePropsMixin.HttpConfigProperty httpConfig) Sets the value ofCfnDataSourceMixinProps.getHttpConfig()httpConfig(IResolvable httpConfig) Sets the value ofCfnDataSourceMixinProps.getHttpConfig()lambdaConfig(CfnDataSourcePropsMixin.LambdaConfigProperty lambdaConfig) Sets the value ofCfnDataSourceMixinProps.getLambdaConfig()lambdaConfig(IResolvable lambdaConfig) Sets the value ofCfnDataSourceMixinProps.getLambdaConfig()metricsConfig(String metricsConfig) Sets the value ofCfnDataSourceMixinProps.getMetricsConfig()Sets the value ofCfnDataSourceMixinProps.getName()openSearchServiceConfig(CfnDataSourcePropsMixin.OpenSearchServiceConfigProperty openSearchServiceConfig) Sets the value ofCfnDataSourceMixinProps.getOpenSearchServiceConfig()openSearchServiceConfig(IResolvable openSearchServiceConfig) Sets the value ofCfnDataSourceMixinProps.getOpenSearchServiceConfig()relationalDatabaseConfig(CfnDataSourcePropsMixin.RelationalDatabaseConfigProperty relationalDatabaseConfig) Sets the value ofCfnDataSourceMixinProps.getRelationalDatabaseConfig()relationalDatabaseConfig(IResolvable relationalDatabaseConfig) Sets the value ofCfnDataSourceMixinProps.getRelationalDatabaseConfig()serviceRoleArn(String serviceRoleArn) Sets the value ofCfnDataSourceMixinProps.getServiceRoleArn()serviceRoleArn(IRoleRef serviceRoleArn) Sets the value ofCfnDataSourceMixinProps.getServiceRoleArn()Sets the value ofCfnDataSourceMixinProps.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiId
Sets the value ofCfnDataSourceMixinProps.getApiId()- Parameters:
apiId- Unique AWS AppSync GraphQL API identifier where this data source will be created.- Returns:
this
-
description
Sets the value ofCfnDataSourceMixinProps.getDescription()- Parameters:
description- The description of the data source.- Returns:
this
-
dynamoDbConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder dynamoDbConfig(IResolvable dynamoDbConfig) Sets the value ofCfnDataSourceMixinProps.getDynamoDbConfig()- Parameters:
dynamoDbConfig- AWS Region and TableName for an Amazon DynamoDB table in your account.- Returns:
this
-
dynamoDbConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder dynamoDbConfig(CfnDataSourcePropsMixin.DynamoDBConfigProperty dynamoDbConfig) Sets the value ofCfnDataSourceMixinProps.getDynamoDbConfig()- Parameters:
dynamoDbConfig- AWS Region and TableName for an Amazon DynamoDB table in your account.- Returns:
this
-
elasticsearchConfig
@Stability(Deprecated) @Deprecated public CfnDataSourceMixinProps.Builder elasticsearchConfig(IResolvable elasticsearchConfig) Deprecated.this property has been deprecatedSets the value ofCfnDataSourceMixinProps.getElasticsearchConfig()- Parameters:
elasticsearchConfig- the value to be set.- Returns:
this
-
elasticsearchConfig
@Stability(Deprecated) @Deprecated public CfnDataSourceMixinProps.Builder elasticsearchConfig(CfnDataSourcePropsMixin.ElasticsearchConfigProperty elasticsearchConfig) Deprecated.this property has been deprecatedSets the value ofCfnDataSourceMixinProps.getElasticsearchConfig()- Parameters:
elasticsearchConfig- the value to be set.- Returns:
this
-
eventBridgeConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder eventBridgeConfig(IResolvable eventBridgeConfig) Sets the value ofCfnDataSourceMixinProps.getEventBridgeConfig()- Parameters:
eventBridgeConfig- An EventBridge configuration that contains a valid ARN of an event bus.- Returns:
this
-
eventBridgeConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder eventBridgeConfig(CfnDataSourcePropsMixin.EventBridgeConfigProperty eventBridgeConfig) Sets the value ofCfnDataSourceMixinProps.getEventBridgeConfig()- Parameters:
eventBridgeConfig- An EventBridge configuration that contains a valid ARN of an event bus.- Returns:
this
-
httpConfig
Sets the value ofCfnDataSourceMixinProps.getHttpConfig()- Parameters:
httpConfig- Endpoints for an HTTP data source.- Returns:
this
-
httpConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder httpConfig(CfnDataSourcePropsMixin.HttpConfigProperty httpConfig) Sets the value ofCfnDataSourceMixinProps.getHttpConfig()- Parameters:
httpConfig- Endpoints for an HTTP data source.- Returns:
this
-
lambdaConfig
Sets the value ofCfnDataSourceMixinProps.getLambdaConfig()- Parameters:
lambdaConfig- An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account.- Returns:
this
-
lambdaConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder lambdaConfig(CfnDataSourcePropsMixin.LambdaConfigProperty lambdaConfig) Sets the value ofCfnDataSourceMixinProps.getLambdaConfig()- Parameters:
lambdaConfig- An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account.- Returns:
this
-
metricsConfig
Sets the value ofCfnDataSourceMixinProps.getMetricsConfig()- Parameters:
metricsConfig- Enables or disables enhanced data source metrics for specified data sources. Note thatMetricsConfigwon't be used unless thedataSourceLevelMetricsBehaviorvalue is set toPER_DATA_SOURCE_METRICS. If thedataSourceLevelMetricsBehavioris set toFULL_REQUEST_DATA_SOURCE_METRICSinstead,MetricsConfigwill be ignored. However, you can still set its value.MetricsConfigcan beENABLEDorDISABLED.- Returns:
this
-
name
Sets the value ofCfnDataSourceMixinProps.getName()- Parameters:
name- Friendly name for you to identify your AppSync data source after creation.- Returns:
this
-
openSearchServiceConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder openSearchServiceConfig(IResolvable openSearchServiceConfig) Sets the value ofCfnDataSourceMixinProps.getOpenSearchServiceConfig()- Parameters:
openSearchServiceConfig- AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.- Returns:
this
-
openSearchServiceConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder openSearchServiceConfig(CfnDataSourcePropsMixin.OpenSearchServiceConfigProperty openSearchServiceConfig) Sets the value ofCfnDataSourceMixinProps.getOpenSearchServiceConfig()- Parameters:
openSearchServiceConfig- AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.- Returns:
this
-
relationalDatabaseConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder relationalDatabaseConfig(IResolvable relationalDatabaseConfig) Sets the value ofCfnDataSourceMixinProps.getRelationalDatabaseConfig()- Parameters:
relationalDatabaseConfig- Relational Database configuration of the relational database data source.- Returns:
this
-
relationalDatabaseConfig
@Stability(Stable) public CfnDataSourceMixinProps.Builder relationalDatabaseConfig(CfnDataSourcePropsMixin.RelationalDatabaseConfigProperty relationalDatabaseConfig) Sets the value ofCfnDataSourceMixinProps.getRelationalDatabaseConfig()- Parameters:
relationalDatabaseConfig- Relational Database configuration of the relational database data source.- Returns:
this
-
serviceRoleArn
Sets the value ofCfnDataSourceMixinProps.getServiceRoleArn()- Parameters:
serviceRoleArn- The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.Required if
Typeis specified asAWS_LAMBDA,AMAZON_DYNAMODB,AMAZON_ELASTICSEARCH,AMAZON_EVENTBRIDGE,AMAZON_OPENSEARCH_SERVICE,RELATIONAL_DATABASE, orAMAZON_BEDROCK_RUNTIME.- Returns:
this
-
serviceRoleArn
Sets the value ofCfnDataSourceMixinProps.getServiceRoleArn()- Parameters:
serviceRoleArn- The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.Required if
Typeis specified asAWS_LAMBDA,AMAZON_DYNAMODB,AMAZON_ELASTICSEARCH,AMAZON_EVENTBRIDGE,AMAZON_OPENSEARCH_SERVICE,RELATIONAL_DATABASE, orAMAZON_BEDROCK_RUNTIME.- Returns:
this
-
type
Sets the value ofCfnDataSourceMixinProps.getType()- Parameters:
type- The type of the data source.- AWS_LAMBDA : The data source is an AWS Lambda function.
- AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
- AMAZON_ELASTICSEARCH : The data source is an Amazon OpenSearch Service domain.
- AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus.
- AMAZON_OPENSEARCH_SERVICE : The data source is an Amazon OpenSearch Service domain.
- AMAZON_BEDROCK_RUNTIME : The data source is the Amazon Bedrock runtime.
- NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
- HTTP : The data source is an HTTP endpoint.
- RELATIONAL_DATABASE : The data source is a relational database.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDataSourceMixinProps>- Returns:
- a new instance of
CfnDataSourceMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-