Documentation ¶
Index ¶
- func CfnApiCache_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiCache_IsCfnElement(x interface{}) *bool
- func CfnApiCache_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApiCache_IsConstruct(x interface{}) *bool
- func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiKey_IsCfnElement(x interface{}) *bool
- func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApiKey_IsConstruct(x interface{}) *bool
- func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataSource_IsCfnElement(x interface{}) *bool
- func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataSource_IsConstruct(x interface{}) *bool
- func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainNameApiAssociation_IsCfnElement(x interface{}) *bool
- func CfnDomainNameApiAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomainNameApiAssociation_IsConstruct(x interface{}) *bool
- func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainName_IsCfnElement(x interface{}) *bool
- func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomainName_IsConstruct(x interface{}) *bool
- func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFunctionConfiguration_IsCfnElement(x interface{}) *bool
- func CfnFunctionConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFunctionConfiguration_IsConstruct(x interface{}) *bool
- func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGraphQLApi_IsCfnElement(x interface{}) *bool
- func CfnGraphQLApi_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGraphQLApi_IsConstruct(x interface{}) *bool
- func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGraphQLSchema_IsCfnElement(x interface{}) *bool
- func CfnGraphQLSchema_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGraphQLSchema_IsConstruct(x interface{}) *bool
- func CfnResolver_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResolver_IsCfnElement(x interface{}) *bool
- func CfnResolver_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResolver_IsConstruct(x interface{}) *bool
- func NewCfnApiCache_Override(c CfnApiCache, scope constructs.Construct, id *string, props *CfnApiCacheProps)
- func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
- func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, ...)
- func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, ...)
- func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope constructs.Construct, id *string, ...)
- func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope constructs.Construct, id *string, ...)
- func NewCfnResolver_Override(c CfnResolver, scope constructs.Construct, id *string, props *CfnResolverProps)
- type CfnApiCache
- type CfnApiCacheProps
- type CfnApiKey
- type CfnApiKeyProps
- type CfnDataSource
- type CfnDataSourceProps
- type CfnDataSource_AuthorizationConfigProperty
- type CfnDataSource_AwsIamConfigProperty
- type CfnDataSource_DeltaSyncConfigProperty
- type CfnDataSource_DynamoDBConfigProperty
- type CfnDataSource_ElasticsearchConfigProperty
- type CfnDataSource_HttpConfigProperty
- type CfnDataSource_LambdaConfigProperty
- type CfnDataSource_OpenSearchServiceConfigProperty
- type CfnDataSource_RdsHttpEndpointConfigProperty
- type CfnDataSource_RelationalDatabaseConfigProperty
- type CfnDomainName
- type CfnDomainNameApiAssociation
- type CfnDomainNameApiAssociationProps
- type CfnDomainNameProps
- type CfnFunctionConfiguration
- type CfnFunctionConfigurationProps
- type CfnFunctionConfiguration_LambdaConflictHandlerConfigProperty
- type CfnFunctionConfiguration_SyncConfigProperty
- type CfnGraphQLApi
- type CfnGraphQLApiProps
- type CfnGraphQLApi_AdditionalAuthenticationProviderProperty
- type CfnGraphQLApi_CognitoUserPoolConfigProperty
- type CfnGraphQLApi_LambdaAuthorizerConfigProperty
- type CfnGraphQLApi_LogConfigProperty
- type CfnGraphQLApi_OpenIDConnectConfigProperty
- type CfnGraphQLApi_UserPoolConfigProperty
- type CfnGraphQLSchema
- type CfnGraphQLSchemaProps
- type CfnResolver
- type CfnResolverProps
- type CfnResolver_CachingConfigProperty
- type CfnResolver_LambdaConflictHandlerConfigProperty
- type CfnResolver_PipelineConfigProperty
- type CfnResolver_SyncConfigProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApiCache_CFN_RESOURCE_TYPE_NAME ¶
func CfnApiCache_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiCache_IsCfnElement ¶
func CfnApiCache_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiCache_IsCfnResource ¶
func CfnApiCache_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApiCache_IsConstruct ¶
func CfnApiCache_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnApiKey_CFN_RESOURCE_TYPE_NAME ¶
func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiKey_IsCfnElement ¶
func CfnApiKey_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiKey_IsCfnResource ¶
func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApiKey_IsConstruct ¶
func CfnApiKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDataSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataSource_IsCfnElement ¶
func CfnDataSource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDataSource_IsCfnResource ¶
func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDataSource_IsConstruct ¶
func CfnDataSource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainNameApiAssociation_IsCfnElement ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomainNameApiAssociation_IsCfnResource ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomainNameApiAssociation_IsConstruct ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDomainName_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainName_IsCfnElement ¶ added in v2.2.0
func CfnDomainName_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomainName_IsCfnResource ¶ added in v2.2.0
func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomainName_IsConstruct ¶ added in v2.2.0
func CfnDomainName_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnFunctionConfiguration_IsCfnElement ¶
func CfnFunctionConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFunctionConfiguration_IsCfnResource ¶
func CfnFunctionConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFunctionConfiguration_IsConstruct ¶
func CfnFunctionConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME ¶
func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME() *string
func CfnGraphQLApi_IsCfnElement ¶
func CfnGraphQLApi_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGraphQLApi_IsCfnResource ¶
func CfnGraphQLApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGraphQLApi_IsConstruct ¶
func CfnGraphQLApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME ¶
func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME() *string
func CfnGraphQLSchema_IsCfnElement ¶
func CfnGraphQLSchema_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGraphQLSchema_IsCfnResource ¶
func CfnGraphQLSchema_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGraphQLSchema_IsConstruct ¶
func CfnGraphQLSchema_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnResolver_CFN_RESOURCE_TYPE_NAME ¶
func CfnResolver_CFN_RESOURCE_TYPE_NAME() *string
func CfnResolver_IsCfnElement ¶
func CfnResolver_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnResolver_IsCfnResource ¶
func CfnResolver_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResolver_IsConstruct ¶
func CfnResolver_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnApiCache_Override ¶
func NewCfnApiCache_Override(c CfnApiCache, scope constructs.Construct, id *string, props *CfnApiCacheProps)
Create a new `AWS::AppSync::ApiCache`.
func NewCfnApiKey_Override ¶
func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
Create a new `AWS::AppSync::ApiKey`.
func NewCfnDataSource_Override ¶
func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, props *CfnDataSourceProps)
Create a new `AWS::AppSync::DataSource`.
func NewCfnDomainNameApiAssociation_Override ¶ added in v2.2.0
func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope constructs.Construct, id *string, props *CfnDomainNameApiAssociationProps)
Create a new `AWS::AppSync::DomainNameApiAssociation`.
func NewCfnDomainName_Override ¶ added in v2.2.0
func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, props *CfnDomainNameProps)
Create a new `AWS::AppSync::DomainName`.
func NewCfnFunctionConfiguration_Override ¶
func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope constructs.Construct, id *string, props *CfnFunctionConfigurationProps)
Create a new `AWS::AppSync::FunctionConfiguration`.
func NewCfnGraphQLApi_Override ¶
func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope constructs.Construct, id *string, props *CfnGraphQLApiProps)
Create a new `AWS::AppSync::GraphQLApi`.
func NewCfnGraphQLSchema_Override ¶
func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope constructs.Construct, id *string, props *CfnGraphQLSchemaProps)
Create a new `AWS::AppSync::GraphQLSchema`.
func NewCfnResolver_Override ¶
func NewCfnResolver_Override(c CfnResolver, scope constructs.Construct, id *string, props *CfnResolverProps)
Create a new `AWS::AppSync::Resolver`.
Types ¶
type CfnApiCache ¶
type CfnApiCache interface { awscdk.CfnResource awscdk.IInspectable ApiCachingBehavior() *string SetApiCachingBehavior(val *string) ApiId() *string SetApiId(val *string) AtRestEncryptionEnabled() interface{} SetAtRestEncryptionEnabled(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack TransitEncryptionEnabled() interface{} SetTransitEncryptionEnabled(val interface{}) Ttl() *float64 SetTtl(val *float64) Type() *string SetType(val *string) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::ApiCache`.
The `AWS::AppSync::ApiCache` resource represents the input of a `CreateApiCache` operation.
TODO: EXAMPLE
func NewCfnApiCache ¶
func NewCfnApiCache(scope constructs.Construct, id *string, props *CfnApiCacheProps) CfnApiCache
Create a new `AWS::AppSync::ApiCache`.
type CfnApiCacheProps ¶
type CfnApiCacheProps struct { // Caching behavior. // // - *FULL_REQUEST_CACHING* : All requests are fully cached. // - *PER_RESOLVER_CACHING* : Individual resolvers that you specify are cached. ApiCachingBehavior *string `json:"apiCachingBehavior"` // The GraphQL API ID. ApiId *string `json:"apiId"` // TTL in seconds for cache entries. // // Valid values are 1–3,600 seconds. Ttl *float64 `json:"ttl"` // The cache instance type. Valid values are. // // - `SMALL` // - `MEDIUM` // - `LARGE` // - `XLARGE` // - `LARGE_2X` // - `LARGE_4X` // - `LARGE_8X` (not available in all regions) // - `LARGE_12X` // // Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used. // // The following legacy instance types are available, but their use is discouraged: // // - *T2_SMALL* : A t2.small instance type. // - *T2_MEDIUM* : A t2.medium instance type. // - *R4_LARGE* : A r4.large instance type. // - *R4_XLARGE* : A r4.xlarge instance type. // - *R4_2XLARGE* : A r4.2xlarge instance type. // - *R4_4XLARGE* : A r4.4xlarge instance type. // - *R4_8XLARGE* : A r4.8xlarge instance type. Type *string `json:"type"` // At-rest encryption flag for cache. // // You cannot update this setting after creation. AtRestEncryptionEnabled interface{} `json:"atRestEncryptionEnabled"` // Transit encryption flag when connecting to cache. // // You cannot update this setting after creation. TransitEncryptionEnabled interface{} `json:"transitEncryptionEnabled"` }
Properties for defining a `CfnApiCache`.
TODO: EXAMPLE
type CfnApiKey ¶
type CfnApiKey interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) ApiKeyId() *string SetApiKeyId(val *string) AttrApiKey() *string AttrArn() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) Expires() *float64 SetExpires(val *float64) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::ApiKey`.
The `AWS::AppSync::ApiKey` resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.
TODO: EXAMPLE
func NewCfnApiKey ¶
func NewCfnApiKey(scope constructs.Construct, id *string, props *CfnApiKeyProps) CfnApiKey
Create a new `AWS::AppSync::ApiKey`.
type CfnApiKeyProps ¶
type CfnApiKeyProps struct { // Unique AWS AppSync GraphQL API ID for this API key. ApiId *string `json:"apiId"` // The API key ID. ApiKeyId *string `json:"apiKeyId"` // Unique description of your API key. Description *string `json:"description"` // The time after which the API key expires. // // The date is represented as seconds since the epoch, rounded down to the nearest hour. Expires *float64 `json:"expires"` }
Properties for defining a `CfnApiKey`.
TODO: EXAMPLE
type CfnDataSource ¶
type CfnDataSource interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) AttrDataSourceArn() *string AttrName() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) DynamoDbConfig() interface{} SetDynamoDbConfig(val interface{}) ElasticsearchConfig() interface{} SetElasticsearchConfig(val interface{}) HttpConfig() interface{} SetHttpConfig(val interface{}) LambdaConfig() interface{} SetLambdaConfig(val interface{}) LogicalId() *string Name() *string SetName(val *string) Node() constructs.Node OpenSearchServiceConfig() interface{} SetOpenSearchServiceConfig(val interface{}) Ref() *string RelationalDatabaseConfig() interface{} SetRelationalDatabaseConfig(val interface{}) ServiceRoleArn() *string SetServiceRoleArn(val *string) Stack() awscdk.Stack Type() *string SetType(val *string) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DataSource`.
The `AWS::AppSync::DataSource` resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service . Resolvers use these data sources to fetch data when clients make GraphQL calls.
TODO: EXAMPLE
func NewCfnDataSource ¶
func NewCfnDataSource(scope constructs.Construct, id *string, props *CfnDataSourceProps) CfnDataSource
Create a new `AWS::AppSync::DataSource`.
type CfnDataSourceProps ¶
type CfnDataSourceProps struct { // Unique AWS AppSync GraphQL API identifier where this data source will be created. ApiId *string `json:"apiId"` // Friendly name for you to identify your AppSync data source after creation. Name *string `json:"name"` // 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_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain. // - *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. Type *string `json:"type"` // The description of the data source. Description *string `json:"description"` // AWS Region and TableName for an Amazon DynamoDB table in your account. DynamoDbConfig interface{} `json:"dynamoDbConfig"` // AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. // // As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use *OpenSearchServiceConfig* to specify an OpenSearch Service data source. ElasticsearchConfig interface{} `json:"elasticsearchConfig"` // Endpoints for an HTTP data source. HttpConfig interface{} `json:"httpConfig"` // 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. LambdaConfig interface{} `json:"lambdaConfig"` // AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. OpenSearchServiceConfig interface{} `json:"openSearchServiceConfig"` // Relational Database configuration of the relational database data source. RelationalDatabaseConfig interface{} `json:"relationalDatabaseConfig"` // 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 `Type` is specified as `AWS_LAMBDA` , `AMAZON_DYNAMODB` , `AMAZON_ELASTICSEARCH` , or `AMAZON_OPENSEARCH_SERVICE` . ServiceRoleArn *string `json:"serviceRoleArn"` }
Properties for defining a `CfnDataSource`.
TODO: EXAMPLE
type CfnDataSource_AuthorizationConfigProperty ¶
type CfnDataSource_AuthorizationConfigProperty struct { // The authorization type that the HTTP endpoint requires. // // - *AWS_IAM* : The authorization type is Signature Version 4 (SigV4). AuthorizationType *string `json:"authorizationType"` // The AWS Identity and Access Management settings. AwsIamConfig interface{} `json:"awsIamConfig"` }
The `AuthorizationConfig` property type specifies the authorization type and configuration for an AWS AppSync http data source.
`AuthorizationConfig` is a property of the [AWS AppSync DataSource HttpConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig.html) property type.
TODO: EXAMPLE
type CfnDataSource_AwsIamConfigProperty ¶
type CfnDataSource_AwsIamConfigProperty struct { // The signing Region for AWS Identity and Access Management authorization. SigningRegion *string `json:"signingRegion"` // The signing service name for AWS Identity and Access Management authorization. SigningServiceName *string `json:"signingServiceName"` }
Use the `AwsIamConfig` property type to specify `AwsIamConfig` for a AWS AppSync authorizaton.
`AwsIamConfig` is a property of the [AWS AppSync DataSource AuthorizationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-httpconfig-authorizationconfig.html) resource.
TODO: EXAMPLE
type CfnDataSource_DeltaSyncConfigProperty ¶
type CfnDataSource_DeltaSyncConfigProperty struct { // The number of minutes that an Item is stored in the data source. BaseTableTtl *string `json:"baseTableTtl"` // The Delta Sync table name. DeltaSyncTableName *string `json:"deltaSyncTableName"` // The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. DeltaSyncTableTtl *string `json:"deltaSyncTableTtl"` }
Describes a Delta Sync configuration.
TODO: EXAMPLE
type CfnDataSource_DynamoDBConfigProperty ¶
type CfnDataSource_DynamoDBConfigProperty struct { // The AWS Region. AwsRegion *string `json:"awsRegion"` // The table name. TableName *string `json:"tableName"` // The `DeltaSyncConfig` for a versioned datasource. DeltaSyncConfig interface{} `json:"deltaSyncConfig"` // Set to `TRUE` to use AWS Identity and Access Management with this data source. UseCallerCredentials interface{} `json:"useCallerCredentials"` // Set to TRUE to use Conflict Detection and Resolution with this data source. Versioned interface{} `json:"versioned"` }
The `DynamoDBConfig` property type specifies the `AwsRegion` and `TableName` for an Amazon DynamoDB table in your account for an AWS AppSync data source.
`DynamoDBConfig` is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) property type.
TODO: EXAMPLE
type CfnDataSource_ElasticsearchConfigProperty ¶
type CfnDataSource_ElasticsearchConfigProperty struct { // The AWS Region. AwsRegion *string `json:"awsRegion"` // The endpoint. Endpoint *string `json:"endpoint"` }
The `ElasticsearchConfig` property type specifies the `AwsRegion` and `Endpoints` for an Amazon OpenSearch Service domain in your account for an AWS AppSync data source.
ElasticsearchConfig is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) property type.
As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service . This property is deprecated. For new data sources, use *OpenSearchServiceConfig* to specify an OpenSearch Service data source.
TODO: EXAMPLE
type CfnDataSource_HttpConfigProperty ¶
type CfnDataSource_HttpConfigProperty struct { // The endpoint. Endpoint *string `json:"endpoint"` // The authorization configuration. AuthorizationConfig interface{} `json:"authorizationConfig"` }
Use the `HttpConfig` property type to specify `HttpConfig` for an AWS AppSync data source.
`HttpConfig` is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) resource.
TODO: EXAMPLE
type CfnDataSource_LambdaConfigProperty ¶
type CfnDataSource_LambdaConfigProperty struct { // The ARN for the Lambda function. LambdaFunctionArn *string `json:"lambdaFunctionArn"` }
The `LambdaConfig` property type specifies the Lambda function ARN for an AWS AppSync data source.
`LambdaConfig` is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) property type.
TODO: EXAMPLE
type CfnDataSource_OpenSearchServiceConfigProperty ¶
type CfnDataSource_OpenSearchServiceConfigProperty struct { // The AWS Region. AwsRegion *string `json:"awsRegion"` // The endpoint. Endpoint *string `json:"endpoint"` }
The `OpenSearchServiceConfig` property type specifies the `AwsRegion` and `Endpoints` for an Amazon OpenSearch Service domain in your account for an AWS AppSync data source.
`OpenSearchServiceConfig` is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) property type.
TODO: EXAMPLE
type CfnDataSource_RdsHttpEndpointConfigProperty ¶
type CfnDataSource_RdsHttpEndpointConfigProperty struct { // AWS Region for RDS HTTP endpoint. AwsRegion *string `json:"awsRegion"` // The ARN for database credentials stored in AWS Secrets Manager . AwsSecretStoreArn *string `json:"awsSecretStoreArn"` // Amazon RDS cluster Amazon Resource Name (ARN). DbClusterIdentifier *string `json:"dbClusterIdentifier"` // Logical database name. DatabaseName *string `json:"databaseName"` // Logical schema name. Schema *string `json:"schema"` }
Use the `RdsHttpEndpointConfig` property type to specify the `RdsHttpEndpoint` for an AWS AppSync relational database.
`RdsHttpEndpointConfig` is a property of the [AWS AppSync DataSource RelationalDatabaseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-relationaldatabaseconfig.html) resource.
TODO: EXAMPLE
type CfnDataSource_RelationalDatabaseConfigProperty ¶
type CfnDataSource_RelationalDatabaseConfigProperty struct { // The type of relational data source. RelationalDatabaseSourceType *string `json:"relationalDatabaseSourceType"` // Information about the Amazon RDS resource. RdsHttpEndpointConfig interface{} `json:"rdsHttpEndpointConfig"` }
Use the `RelationalDatabaseConfig` property type to specify `RelationalDatabaseConfig` for an AWS AppSync data source.
`RelationalDatabaseConfig` is a property of the [AWS::AppSync::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html) property type.
TODO: EXAMPLE
type CfnDomainName ¶ added in v2.2.0
type CfnDomainName interface { awscdk.CfnResource awscdk.IInspectable AttrAppSyncDomainName() *string AttrDomainName() *string AttrHostedZoneId() *string CertificateArn() *string SetCertificateArn(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) DomainName() *string SetDomainName(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DomainName`.
The `AWS::AppSync::DomainName` resource creates a `DomainNameConfig` object to configure a custom domain.
TODO: EXAMPLE
func NewCfnDomainName ¶ added in v2.2.0
func NewCfnDomainName(scope constructs.Construct, id *string, props *CfnDomainNameProps) CfnDomainName
Create a new `AWS::AppSync::DomainName`.
type CfnDomainNameApiAssociation ¶ added in v2.2.0
type CfnDomainNameApiAssociation interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) AttrApiAssociationIdentifier() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DomainName() *string SetDomainName(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DomainNameApiAssociation`.
The `AWS::AppSync::DomainNameApiAssociation` resource represents the mapping of your custom domain name to the assigned API URL.
TODO: EXAMPLE
func NewCfnDomainNameApiAssociation ¶ added in v2.2.0
func NewCfnDomainNameApiAssociation(scope constructs.Construct, id *string, props *CfnDomainNameApiAssociationProps) CfnDomainNameApiAssociation
Create a new `AWS::AppSync::DomainNameApiAssociation`.
type CfnDomainNameApiAssociationProps ¶ added in v2.2.0
type CfnDomainNameApiAssociationProps struct { // The API ID. ApiId *string `json:"apiId"` // The domain name. DomainName *string `json:"domainName"` }
Properties for defining a `CfnDomainNameApiAssociation`.
TODO: EXAMPLE
type CfnDomainNameProps ¶ added in v2.2.0
type CfnDomainNameProps struct { // The Amazon Resource Name (ARN) of the certificate. // // This will be an AWS Certificate Manager certificate. CertificateArn *string `json:"certificateArn"` // The domain name. DomainName *string `json:"domainName"` // The decription for your domain name. Description *string `json:"description"` }
Properties for defining a `CfnDomainName`.
TODO: EXAMPLE
type CfnFunctionConfiguration ¶
type CfnFunctionConfiguration interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) AttrDataSourceName() *string AttrFunctionArn() *string AttrFunctionId() *string AttrName() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DataSourceName() *string SetDataSourceName(val *string) Description() *string SetDescription(val *string) FunctionVersion() *string SetFunctionVersion(val *string) LogicalId() *string Name() *string SetName(val *string) Node() constructs.Node Ref() *string RequestMappingTemplate() *string SetRequestMappingTemplate(val *string) RequestMappingTemplateS3Location() *string SetRequestMappingTemplateS3Location(val *string) ResponseMappingTemplate() *string SetResponseMappingTemplate(val *string) ResponseMappingTemplateS3Location() *string SetResponseMappingTemplateS3Location(val *string) Stack() awscdk.Stack SyncConfig() interface{} SetSyncConfig(val interface{}) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::FunctionConfiguration`.
The `AWS::AppSync::FunctionConfiguration` resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see [Pipeline Resolvers](https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html) in the *AWS AppSync Developer Guide* .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the AWS CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
TODO: EXAMPLE
func NewCfnFunctionConfiguration ¶
func NewCfnFunctionConfiguration(scope constructs.Construct, id *string, props *CfnFunctionConfigurationProps) CfnFunctionConfiguration
Create a new `AWS::AppSync::FunctionConfiguration`.
type CfnFunctionConfigurationProps ¶
type CfnFunctionConfigurationProps struct { // The AWS AppSync GraphQL API that you want to attach using this function. ApiId *string `json:"apiId"` // The name of data source this function will attach. DataSourceName *string `json:"dataSourceName"` // The version of the request mapping template. // // Currently, only the 2018-05-29 version of the template is supported. FunctionVersion *string `json:"functionVersion"` // The name of the function. Name *string `json:"name"` // The `Function` description. Description *string `json:"description"` // The `Function` request mapping template. // // Functions support only the 2018-05-29 version of the request mapping template. RequestMappingTemplate *string `json:"requestMappingTemplate"` // Describes a Sync configuration for a resolver. // // Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked. RequestMappingTemplateS3Location *string `json:"requestMappingTemplateS3Location"` // The `Function` response mapping template. ResponseMappingTemplate *string `json:"responseMappingTemplate"` // The location of a response mapping template in an Amazon S3 bucket. // // Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. ResponseMappingTemplateS3Location *string `json:"responseMappingTemplateS3Location"` // Describes a Sync configuration for a resolver. // // Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked. SyncConfig interface{} `json:"syncConfig"` }
Properties for defining a `CfnFunctionConfiguration`.
TODO: EXAMPLE
type CfnFunctionConfiguration_LambdaConflictHandlerConfigProperty ¶
type CfnFunctionConfiguration_LambdaConflictHandlerConfigProperty struct { // The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. LambdaConflictHandlerArn *string `json:"lambdaConflictHandlerArn"` }
The `LambdaConflictHandlerConfig` object when configuring `LAMBDA` as the Conflict Handler.
TODO: EXAMPLE
type CfnFunctionConfiguration_SyncConfigProperty ¶
type CfnFunctionConfiguration_SyncConfigProperty struct { // The Conflict Detection strategy to use. // // - *VERSION* : Detect conflicts based on object versions for this resolver. // - *NONE* : Do not detect conflicts when invoking this resolver. ConflictDetection *string `json:"conflictDetection"` // The Conflict Resolution strategy to perform in the event of a conflict. // // - *OPTIMISTIC_CONCURRENCY* : Resolve conflicts by rejecting mutations when versions don't match the latest version at the server. // - *AUTOMERGE* : Resolve conflicts with the Automerge conflict resolution strategy. // - *LAMBDA* : Resolve conflicts with an AWS Lambda function supplied in the `LambdaConflictHandlerConfig` . ConflictHandler *string `json:"conflictHandler"` // The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler. LambdaConflictHandlerConfig interface{} `json:"lambdaConflictHandlerConfig"` }
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
TODO: EXAMPLE
type CfnGraphQLApi ¶
type CfnGraphQLApi interface { awscdk.CfnResource awscdk.IInspectable AdditionalAuthenticationProviders() interface{} SetAdditionalAuthenticationProviders(val interface{}) AttrApiId() *string AttrArn() *string AttrGraphQlUrl() *string AuthenticationType() *string SetAuthenticationType(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LambdaAuthorizerConfig() interface{} SetLambdaAuthorizerConfig(val interface{}) LogConfig() interface{} SetLogConfig(val interface{}) LogicalId() *string Name() *string SetName(val *string) Node() constructs.Node OpenIdConnectConfig() interface{} SetOpenIdConnectConfig(val interface{}) Ref() *string Stack() awscdk.Stack Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} UserPoolConfig() interface{} SetUserPoolConfig(val interface{}) XrayEnabled() interface{} SetXrayEnabled(val interface{}) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::GraphQLApi`.
The `AWS::AppSync::GraphQLApi` resource creates a new AWS AppSync GraphQL API. This is the top-level construct for your application. For more information, see [Quick Start](https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html) in the *AWS AppSync Developer Guide* .
TODO: EXAMPLE
func NewCfnGraphQLApi ¶
func NewCfnGraphQLApi(scope constructs.Construct, id *string, props *CfnGraphQLApiProps) CfnGraphQLApi
Create a new `AWS::AppSync::GraphQLApi`.
type CfnGraphQLApiProps ¶
type CfnGraphQLApiProps struct { // Security configuration for your GraphQL API. // // For allowed values (such as `API_KEY` , `AWS_IAM` , `AMAZON_COGNITO_USER_POOLS` , `OPENID_CONNECT` , or `AWS_LAMBDA` ), see [Security](https://docs.aws.amazon.com/appsync/latest/devguide/security.html) in the *AWS AppSync Developer Guide* . AuthenticationType *string `json:"authenticationType"` // The API name. Name *string `json:"name"` // A list of additional authentication providers for the `GraphqlApi` API. AdditionalAuthenticationProviders interface{} `json:"additionalAuthenticationProviders"` // A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode. // // Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time. LambdaAuthorizerConfig interface{} `json:"lambdaAuthorizerConfig"` // The Amazon CloudWatch Logs configuration. LogConfig interface{} `json:"logConfig"` // The OpenID Connect configuration. OpenIdConnectConfig interface{} `json:"openIdConnectConfig"` // An arbitrary set of tags (key-value pairs) for this GraphQL API. Tags interface{} `json:"tags"` // Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. UserPoolConfig interface{} `json:"userPoolConfig"` // A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` . XrayEnabled interface{} `json:"xrayEnabled"` }
Properties for defining a `CfnGraphQLApi`.
TODO: EXAMPLE
type CfnGraphQLApi_AdditionalAuthenticationProviderProperty ¶
type CfnGraphQLApi_AdditionalAuthenticationProviderProperty struct { // The authentication type for API key, AWS Identity and Access Management , OIDC, Amazon Cognito user pools , or AWS Lambda . // // Valid Values: `API_KEY` | `AWS_IAM` | `OPENID_CONNECT` | `AMAZON_COGNITO_USER_POOLS` | `AWS_LAMBDA` AuthenticationType *string `json:"authenticationType"` // Configuration for AWS Lambda function authorization. LambdaAuthorizerConfig interface{} `json:"lambdaAuthorizerConfig"` // The OIDC configuration. OpenIdConnectConfig interface{} `json:"openIdConnectConfig"` // The Amazon Cognito user pool configuration. UserPoolConfig interface{} `json:"userPoolConfig"` }
Describes an additional authentication provider.
TODO: EXAMPLE
type CfnGraphQLApi_CognitoUserPoolConfigProperty ¶
type CfnGraphQLApi_CognitoUserPoolConfigProperty struct { // A regular expression for validating the incoming Amazon Cognito user pool app client ID. AppIdClientRegex *string `json:"appIdClientRegex"` // The AWS Region in which the user pool was created. AwsRegion *string `json:"awsRegion"` // The user pool ID. UserPoolId *string `json:"userPoolId"` }
Describes an Amazon Cognito user pool configuration.
TODO: EXAMPLE
type CfnGraphQLApi_LambdaAuthorizerConfigProperty ¶
type CfnGraphQLApi_LambdaAuthorizerConfigProperty struct { // The number of seconds a response should be cached for. // // The default is 5 minutes (300 seconds). The Lambda function can override this by returning a `ttlOverride` key in its response. A value of 0 disables caching of responses. AuthorizerResultTtlInSeconds *float64 `json:"authorizerResultTtlInSeconds"` // The ARN of the Lambda function to be called for authorization. // // This may be a standard Lambda ARN, a version ARN ( `.../v3` ) or alias ARN. // // *Note* : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To do so with the AWS CLI , run the following: // // `aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction` AuthorizerUri *string `json:"authorizerUri"` // A regular expression for validation of tokens before the Lambda function is called. IdentityValidationExpression *string `json:"identityValidationExpression"` }
Configuration for AWS Lambda function authorization.
TODO: EXAMPLE
type CfnGraphQLApi_LogConfigProperty ¶
type CfnGraphQLApi_LogConfigProperty struct { // The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. CloudWatchLogsRoleArn *string `json:"cloudWatchLogsRoleArn"` // Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. ExcludeVerboseContent interface{} `json:"excludeVerboseContent"` // The field logging level. Values can be NONE, ERROR, or ALL. // // - *NONE* : No field-level logs are captured. // - *ERROR* : Logs the following information only for the fields that are in error: // // - The error section in the server response. // - Field-level errors. // - The generated request/response functions that got resolved for error fields. // - *ALL* : The following information is logged for all fields in the query: // // - Field-level tracing information. // - The generated request/response functions that got resolved for each field. FieldLogLevel *string `json:"fieldLogLevel"` }
The `LogConfig` property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
`LogConfig` is a property of the [AWS::AppSync::GraphQLApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html) property type.
TODO: EXAMPLE
type CfnGraphQLApi_OpenIDConnectConfigProperty ¶
type CfnGraphQLApi_OpenIDConnectConfigProperty struct { // The number of milliseconds that a token is valid after being authenticated. AuthTtl *float64 `json:"authTtl"` // The client identifier of the Relying party at the OpenID identity provider. // // This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so that AWS AppSync can validate against multiple client identifiers at a time. ClientId *string `json:"clientId"` // The number of milliseconds that a token is valid after it's issued to a user. IatTtl *float64 `json:"iatTtl"` // The issuer for the OIDC configuration. // // The issuer returned by discovery must exactly match the value of `iss` in the ID token. Issuer *string `json:"issuer"` }
The `OpenIDConnectConfig` property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API.
`OpenIDConnectConfig` is a property of the [AWS::AppSync::GraphQLApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html) property type.
TODO: EXAMPLE
type CfnGraphQLApi_UserPoolConfigProperty ¶
type CfnGraphQLApi_UserPoolConfigProperty struct { // A regular expression for validating the incoming Amazon Cognito user pool app client ID. AppIdClientRegex *string `json:"appIdClientRegex"` // The AWS Region in which the user pool was created. AwsRegion *string `json:"awsRegion"` // The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. // // When specifying Amazon Cognito user pools as the default authentication, you must set the value for `DefaultAction` to `ALLOW` if specifying `AdditionalAuthenticationProviders` . DefaultAction *string `json:"defaultAction"` // The user pool ID. UserPoolId *string `json:"userPoolId"` }
The `UserPoolConfig` property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API.
TODO: EXAMPLE
type CfnGraphQLSchema ¶
type CfnGraphQLSchema interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Definition() *string SetDefinition(val *string) DefinitionS3Location() *string SetDefinitionS3Location(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::GraphQLSchema`.
The `AWS::AppSync::GraphQLSchema` resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema files are text written in Schema Definition Language (SDL) format. For more information about schema authoring, see [Designing a GraphQL API](https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html) in the *AWS AppSync Developer Guide* .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
TODO: EXAMPLE
func NewCfnGraphQLSchema ¶
func NewCfnGraphQLSchema(scope constructs.Construct, id *string, props *CfnGraphQLSchemaProps) CfnGraphQLSchema
Create a new `AWS::AppSync::GraphQLSchema`.
type CfnGraphQLSchemaProps ¶
type CfnGraphQLSchemaProps struct { // The AWS AppSync GraphQL API identifier to which you want to apply this schema. ApiId *string `json:"apiId"` // The text representation of a GraphQL schema in SDL format. // // For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref) . Definition *string `json:"definition"` // The location of a GraphQL schema file in an Amazon S3 bucket. // // Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template. DefinitionS3Location *string `json:"definitionS3Location"` }
Properties for defining a `CfnGraphQLSchema`.
TODO: EXAMPLE
type CfnResolver ¶
type CfnResolver interface { awscdk.CfnResource awscdk.IInspectable ApiId() *string SetApiId(val *string) AttrFieldName() *string AttrResolverArn() *string AttrTypeName() *string CachingConfig() interface{} SetCachingConfig(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DataSourceName() *string SetDataSourceName(val *string) FieldName() *string SetFieldName(val *string) Kind() *string SetKind(val *string) LogicalId() *string Node() constructs.Node PipelineConfig() interface{} SetPipelineConfig(val interface{}) Ref() *string RequestMappingTemplate() *string SetRequestMappingTemplate(val *string) RequestMappingTemplateS3Location() *string SetRequestMappingTemplateS3Location(val *string) ResponseMappingTemplate() *string SetResponseMappingTemplate(val *string) ResponseMappingTemplateS3Location() *string SetResponseMappingTemplateS3Location(val *string) Stack() awscdk.Stack SyncConfig() interface{} SetSyncConfig(val interface{}) TypeName() *string SetTypeName(val *string) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::Resolver`.
The `AWS::AppSync::Resolver` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html) .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
TODO: EXAMPLE
func NewCfnResolver ¶
func NewCfnResolver(scope constructs.Construct, id *string, props *CfnResolverProps) CfnResolver
Create a new `AWS::AppSync::Resolver`.
type CfnResolverProps ¶
type CfnResolverProps struct { // The AWS AppSync GraphQL API to which you want to attach this resolver. ApiId *string `json:"apiId"` // The GraphQL field on a type that invokes the resolver. FieldName *string `json:"fieldName"` // The GraphQL type that invokes this resolver. TypeName *string `json:"typeName"` // The caching configuration for the resolver. CachingConfig interface{} `json:"cachingConfig"` // The resolver data source name. DataSourceName *string `json:"dataSourceName"` // The resolver type. // // - *UNIT* : A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. // - *PIPELINE* : A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. Kind *string `json:"kind"` // Functions linked with the pipeline resolver. PipelineConfig interface{} `json:"pipelineConfig"` // The request mapping template. // // Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required. RequestMappingTemplate *string `json:"requestMappingTemplate"` // The location of a request mapping template in an Amazon S3 bucket. // // Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. RequestMappingTemplateS3Location *string `json:"requestMappingTemplateS3Location"` // The response mapping template. ResponseMappingTemplate *string `json:"responseMappingTemplate"` // The location of a response mapping template in an Amazon S3 bucket. // // Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. ResponseMappingTemplateS3Location *string `json:"responseMappingTemplateS3Location"` // The `SyncConfig` for a resolver attached to a versioned data source. SyncConfig interface{} `json:"syncConfig"` }
Properties for defining a `CfnResolver`.
TODO: EXAMPLE
type CfnResolver_CachingConfigProperty ¶
type CfnResolver_CachingConfigProperty struct { // The caching keys for a resolver that has caching activated. // // Valid values are entries from the `$context.arguments` , `$context.source` , and `$context.identity` maps. CachingKeys *[]*string `json:"cachingKeys"` // The TTL in seconds for a resolver that has caching activated. // // Valid values are 1–3,600 seconds. Ttl *float64 `json:"ttl"` }
The caching configuration for a resolver that has caching activated.
TODO: EXAMPLE
type CfnResolver_LambdaConflictHandlerConfigProperty ¶
type CfnResolver_LambdaConflictHandlerConfigProperty struct { // The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. LambdaConflictHandlerArn *string `json:"lambdaConflictHandlerArn"` }
The `LambdaConflictHandlerConfig` when configuring LAMBDA as the Conflict Handler.
TODO: EXAMPLE
type CfnResolver_PipelineConfigProperty ¶
type CfnResolver_PipelineConfigProperty struct { // A list of `Function` objects. Functions *[]*string `json:"functions"` }
Use the `PipelineConfig` property type to specify `PipelineConfig` for an AWS AppSync resolver.
`PipelineConfig` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.
TODO: EXAMPLE
type CfnResolver_SyncConfigProperty ¶
type CfnResolver_SyncConfigProperty struct { // The Conflict Detection strategy to use. // // - *VERSION* : Detect conflicts based on object versions for this resolver. // - *NONE* : Do not detect conflicts when invoking this resolver. ConflictDetection *string `json:"conflictDetection"` // The Conflict Resolution strategy to perform in the event of a conflict. // // - *OPTIMISTIC_CONCURRENCY* : Resolve conflicts by rejecting mutations when versions don't match the latest version at the server. // - *AUTOMERGE* : Resolve conflicts with the Automerge conflict resolution strategy. // - *LAMBDA* : Resolve conflicts with an AWS Lambda function supplied in the `LambdaConflictHandlerConfig` . ConflictHandler *string `json:"conflictHandler"` // The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler. LambdaConflictHandlerConfig interface{} `json:"lambdaConflictHandlerConfig"` }
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
TODO: EXAMPLE