Documentation ¶
Index ¶
- func AppsyncFunction_IsConstruct(x interface{}) *bool
- func AppsyncFunction_IsResource(construct awscdk.IConstruct) *bool
- func BackedDataSource_IsConstruct(x interface{}) *bool
- func BaseDataSource_IsConstruct(x interface{}) *bool
- 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 DynamoDbDataSource_IsConstruct(x interface{}) *bool
- func ElasticsearchDataSource_IsConstruct(x interface{}) *bool
- func GraphqlApiBase_IsConstruct(x interface{}) *bool
- func GraphqlApiBase_IsResource(construct awscdk.IConstruct) *bool
- func GraphqlApi_IsConstruct(x interface{}) *bool
- func GraphqlApi_IsResource(construct awscdk.IConstruct) *bool
- func HttpDataSource_IsConstruct(x interface{}) *bool
- func LambdaDataSource_IsConstruct(x interface{}) *bool
- func NewAppsyncFunction_Override(a AppsyncFunction, scope constructs.Construct, id *string, ...)
- func NewAssign_Override(a Assign, attr *string, arg *string)
- func NewAttributeValuesStep_Override(a AttributeValuesStep, attr *string, container *string, assignments *[]Assign)
- func NewAttributeValues_Override(a AttributeValues, container *string, assignments *[]Assign)
- func NewBackedDataSource_Override(b BackedDataSource, scope constructs.Construct, id *string, ...)
- func NewBaseDataSource_Override(b BaseDataSource, scope constructs.Construct, id *string, ...)
- func NewCfnApiCache_Override(c CfnApiCache, scope awscdk.Construct, id *string, props *CfnApiCacheProps)
- func NewCfnApiKey_Override(c CfnApiKey, scope awscdk.Construct, id *string, props *CfnApiKeyProps)
- func NewCfnDataSource_Override(c CfnDataSource, scope awscdk.Construct, id *string, props *CfnDataSourceProps)
- func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope awscdk.Construct, id *string, ...)
- func NewCfnDomainName_Override(c CfnDomainName, scope awscdk.Construct, id *string, props *CfnDomainNameProps)
- func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope awscdk.Construct, id *string, ...)
- func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope awscdk.Construct, id *string, props *CfnGraphQLApiProps)
- func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope awscdk.Construct, id *string, ...)
- func NewCfnResolver_Override(c CfnResolver, scope awscdk.Construct, id *string, props *CfnResolverProps)
- func NewDynamoDbDataSource_Override(d DynamoDbDataSource, scope constructs.Construct, id *string, ...)
- func NewElasticsearchDataSource_Override(e ElasticsearchDataSource, scope constructs.Construct, id *string, ...)
- func NewEnumType_Override(e EnumType, name *string, options *EnumTypeOptions)
- func NewField_Override(f Field, options *FieldOptions)
- func NewGraphqlApiBase_Override(g GraphqlApiBase, scope constructs.Construct, id *string, ...)
- func NewGraphqlApi_Override(g GraphqlApi, scope constructs.Construct, id *string, props *GraphqlApiProps)
- func NewGraphqlType_Override(g GraphqlType, type_ Type, options *GraphqlTypeOptions)
- func NewHttpDataSource_Override(h HttpDataSource, scope constructs.Construct, id *string, ...)
- func NewInputType_Override(i InputType, name *string, props *IntermediateTypeOptions)
- func NewInterfaceType_Override(i InterfaceType, name *string, props *IntermediateTypeOptions)
- func NewLambdaDataSource_Override(l LambdaDataSource, scope constructs.Construct, id *string, ...)
- func NewMappingTemplate_Override(m MappingTemplate)
- func NewNoneDataSource_Override(n NoneDataSource, scope constructs.Construct, id *string, ...)
- func NewObjectType_Override(o ObjectType, name *string, props *ObjectTypeOptions)
- func NewPartitionKeyStep_Override(p PartitionKeyStep, key *string)
- func NewPartitionKey_Override(p PartitionKey, pkey Assign)
- func NewPrimaryKey_Override(p PrimaryKey, pkey Assign, skey Assign)
- func NewRdsDataSource_Override(r RdsDataSource, scope constructs.Construct, id *string, ...)
- func NewResolvableField_Override(r ResolvableField, options *ResolvableFieldOptions)
- func NewResolver_Override(r Resolver, scope constructs.Construct, id *string, props *ResolverProps)
- func NewSchema_Override(s Schema, options *SchemaOptions)
- func NewSortKeyStep_Override(s SortKeyStep, pkey Assign, skey *string)
- func NewUnionType_Override(u UnionType, name *string, options *UnionTypeOptions)
- func NewValues_Override(v Values)
- func NoneDataSource_IsConstruct(x interface{}) *bool
- func RdsDataSource_IsConstruct(x interface{}) *bool
- func Resolver_IsConstruct(x interface{}) *bool
- type AddFieldOptions
- type ApiKeyConfig
- type AppsyncFunction
- type AppsyncFunctionAttributes
- type AppsyncFunctionProps
- type Assign
- type AttributeValues
- type AttributeValuesStep
- type AuthorizationConfig
- type AuthorizationMode
- type AuthorizationType
- type AwsIamConfig
- type BackedDataSource
- type BackedDataSourceProps
- type BaseAppsyncFunctionProps
- type BaseDataSource
- type BaseDataSourceProps
- type BaseResolverProps
- type BaseTypeOptions
- type CachingConfig
- 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
- type DataSourceOptions
- type Directive
- type DynamoDbDataSource
- type DynamoDbDataSourceProps
- type ElasticsearchDataSource
- type ElasticsearchDataSourceProps
- type EnumType
- type EnumTypeOptions
- type ExtendedDataSourceProps
- type ExtendedResolverProps
- type Field
- type FieldLogLevel
- type FieldOptions
- type GraphqlApi
- type GraphqlApiAttributes
- type GraphqlApiBase
- type GraphqlApiProps
- type GraphqlType
- func Field_AwsDate(options *BaseTypeOptions) GraphqlType
- func Field_AwsDateTime(options *BaseTypeOptions) GraphqlType
- func Field_AwsEmail(options *BaseTypeOptions) GraphqlType
- func Field_AwsIpAddress(options *BaseTypeOptions) GraphqlType
- func Field_AwsJson(options *BaseTypeOptions) GraphqlType
- func Field_AwsPhone(options *BaseTypeOptions) GraphqlType
- func Field_AwsTime(options *BaseTypeOptions) GraphqlType
- func Field_AwsTimestamp(options *BaseTypeOptions) GraphqlType
- func Field_AwsUrl(options *BaseTypeOptions) GraphqlType
- func Field_Boolean(options *BaseTypeOptions) GraphqlType
- func Field_Float(options *BaseTypeOptions) GraphqlType
- func Field_Id(options *BaseTypeOptions) GraphqlType
- func Field_Int(options *BaseTypeOptions) GraphqlType
- func Field_Intermediate(options *GraphqlTypeOptions) GraphqlType
- func Field_String(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsDate(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsDateTime(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsEmail(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsIpAddress(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsJson(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsPhone(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsTime(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsTimestamp(options *BaseTypeOptions) GraphqlType
- func GraphqlType_AwsUrl(options *BaseTypeOptions) GraphqlType
- func GraphqlType_Boolean(options *BaseTypeOptions) GraphqlType
- func GraphqlType_Float(options *BaseTypeOptions) GraphqlType
- func GraphqlType_Id(options *BaseTypeOptions) GraphqlType
- func GraphqlType_Int(options *BaseTypeOptions) GraphqlType
- func GraphqlType_Intermediate(options *GraphqlTypeOptions) GraphqlType
- func GraphqlType_String(options *BaseTypeOptions) GraphqlType
- func NewGraphqlType(type_ Type, options *GraphqlTypeOptions) GraphqlType
- func ResolvableField_AwsDate(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsDateTime(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsEmail(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsIpAddress(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsJson(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsPhone(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsTime(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsTimestamp(options *BaseTypeOptions) GraphqlType
- func ResolvableField_AwsUrl(options *BaseTypeOptions) GraphqlType
- func ResolvableField_Boolean(options *BaseTypeOptions) GraphqlType
- func ResolvableField_Float(options *BaseTypeOptions) GraphqlType
- func ResolvableField_Id(options *BaseTypeOptions) GraphqlType
- func ResolvableField_Int(options *BaseTypeOptions) GraphqlType
- func ResolvableField_Intermediate(options *GraphqlTypeOptions) GraphqlType
- func ResolvableField_String(options *BaseTypeOptions) GraphqlType
- type GraphqlTypeOptions
- type HttpDataSource
- type HttpDataSourceOptions
- type HttpDataSourceProps
- type IAppsyncFunction
- type IField
- type IGraphqlApi
- type IIntermediateType
- type IamResource
- type InputType
- type InterfaceType
- type IntermediateTypeOptions
- type KeyCondition
- func KeyCondition_BeginsWith(keyName *string, arg *string) KeyCondition
- func KeyCondition_Between(keyName *string, arg1 *string, arg2 *string) KeyCondition
- func KeyCondition_Eq(keyName *string, arg *string) KeyCondition
- func KeyCondition_Ge(keyName *string, arg *string) KeyCondition
- func KeyCondition_Gt(keyName *string, arg *string) KeyCondition
- func KeyCondition_Le(keyName *string, arg *string) KeyCondition
- func KeyCondition_Lt(keyName *string, arg *string) KeyCondition
- type LambdaAuthorizerConfig
- type LambdaDataSource
- type LambdaDataSourceProps
- type LogConfig
- type MappingTemplate
- func MappingTemplate_DynamoDbDeleteItem(keyName *string, idArg *string) MappingTemplate
- func MappingTemplate_DynamoDbGetItem(keyName *string, idArg *string) MappingTemplate
- func MappingTemplate_DynamoDbPutItem(key PrimaryKey, values AttributeValues) MappingTemplate
- func MappingTemplate_DynamoDbQuery(cond KeyCondition, indexName *string) MappingTemplate
- func MappingTemplate_DynamoDbResultItem() MappingTemplate
- func MappingTemplate_DynamoDbResultList() MappingTemplate
- func MappingTemplate_DynamoDbScanTable() MappingTemplate
- func MappingTemplate_FromFile(fileName *string) MappingTemplate
- func MappingTemplate_FromString(template *string) MappingTemplate
- func MappingTemplate_LambdaRequest(payload *string, operation *string) MappingTemplate
- func MappingTemplate_LambdaResult() MappingTemplate
- type NoneDataSource
- type NoneDataSourceProps
- type ObjectType
- type ObjectTypeOptions
- type OpenIdConnectConfig
- type PartitionKey
- type PartitionKeyStep
- type PrimaryKey
- type RdsDataSource
- type RdsDataSourceProps
- type ResolvableField
- type ResolvableFieldOptions
- type Resolver
- type ResolverProps
- type Schema
- type SchemaOptions
- type SortKeyStep
- type Type
- type UnionType
- type UnionTypeOptions
- type UserPoolConfig
- type UserPoolDefaultAction
- type Values
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AppsyncFunction_IsConstruct ¶
func AppsyncFunction_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func AppsyncFunction_IsResource ¶
func AppsyncFunction_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func BackedDataSource_IsConstruct ¶
func BackedDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func BaseDataSource_IsConstruct ¶
func BaseDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnApiCache_IsCfnResource ¶
func CfnApiCache_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnApiCache_IsConstruct ¶
func CfnApiCache_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnApiKey_IsCfnResource ¶
func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnApiKey_IsConstruct ¶
func CfnApiKey_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnDataSource_IsCfnResource ¶
func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataSource_IsConstruct ¶
func CfnDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainNameApiAssociation_IsCfnElement ¶
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. Experimental.
func CfnDomainNameApiAssociation_IsCfnResource ¶
func CfnDomainNameApiAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDomainNameApiAssociation_IsConstruct ¶
func CfnDomainNameApiAssociation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDomainName_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainName_IsCfnElement ¶
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. Experimental.
func CfnDomainName_IsCfnResource ¶
func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDomainName_IsConstruct ¶
func CfnDomainName_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnFunctionConfiguration_IsCfnResource ¶
func CfnFunctionConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnFunctionConfiguration_IsConstruct ¶
func CfnFunctionConfiguration_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnGraphQLApi_IsCfnResource ¶
func CfnGraphQLApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnGraphQLApi_IsConstruct ¶
func CfnGraphQLApi_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnGraphQLSchema_IsCfnResource ¶
func CfnGraphQLSchema_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnGraphQLSchema_IsConstruct ¶
func CfnGraphQLSchema_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnResolver_IsCfnResource ¶
func CfnResolver_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnResolver_IsConstruct ¶
func CfnResolver_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func DynamoDbDataSource_IsConstruct ¶
func DynamoDbDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func ElasticsearchDataSource_IsConstruct ¶
func ElasticsearchDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func GraphqlApiBase_IsConstruct ¶
func GraphqlApiBase_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func GraphqlApiBase_IsResource ¶
func GraphqlApiBase_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func GraphqlApi_IsConstruct ¶
func GraphqlApi_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func GraphqlApi_IsResource ¶
func GraphqlApi_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func HttpDataSource_IsConstruct ¶
func HttpDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func LambdaDataSource_IsConstruct ¶
func LambdaDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewAppsyncFunction_Override ¶
func NewAppsyncFunction_Override(a AppsyncFunction, scope constructs.Construct, id *string, props *AppsyncFunctionProps)
Experimental.
func NewAssign_Override ¶
Experimental.
func NewAttributeValuesStep_Override ¶
func NewAttributeValuesStep_Override(a AttributeValuesStep, attr *string, container *string, assignments *[]Assign)
Experimental.
func NewAttributeValues_Override ¶
func NewAttributeValues_Override(a AttributeValues, container *string, assignments *[]Assign)
Experimental.
func NewBackedDataSource_Override ¶
func NewBackedDataSource_Override(b BackedDataSource, scope constructs.Construct, id *string, props *BackedDataSourceProps, extended *ExtendedDataSourceProps)
Experimental.
func NewBaseDataSource_Override ¶
func NewBaseDataSource_Override(b BaseDataSource, scope constructs.Construct, id *string, props *BackedDataSourceProps, extended *ExtendedDataSourceProps)
Experimental.
func NewCfnApiCache_Override ¶
func NewCfnApiCache_Override(c CfnApiCache, scope awscdk.Construct, id *string, props *CfnApiCacheProps)
Create a new `AWS::AppSync::ApiCache`.
func NewCfnApiKey_Override ¶
func NewCfnApiKey_Override(c CfnApiKey, scope awscdk.Construct, id *string, props *CfnApiKeyProps)
Create a new `AWS::AppSync::ApiKey`.
func NewCfnDataSource_Override ¶
func NewCfnDataSource_Override(c CfnDataSource, scope awscdk.Construct, id *string, props *CfnDataSourceProps)
Create a new `AWS::AppSync::DataSource`.
func NewCfnDomainNameApiAssociation_Override ¶
func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope awscdk.Construct, id *string, props *CfnDomainNameApiAssociationProps)
Create a new `AWS::AppSync::DomainNameApiAssociation`.
func NewCfnDomainName_Override ¶
func NewCfnDomainName_Override(c CfnDomainName, scope awscdk.Construct, id *string, props *CfnDomainNameProps)
Create a new `AWS::AppSync::DomainName`.
func NewCfnFunctionConfiguration_Override ¶
func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope awscdk.Construct, id *string, props *CfnFunctionConfigurationProps)
Create a new `AWS::AppSync::FunctionConfiguration`.
func NewCfnGraphQLApi_Override ¶
func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope awscdk.Construct, id *string, props *CfnGraphQLApiProps)
Create a new `AWS::AppSync::GraphQLApi`.
func NewCfnGraphQLSchema_Override ¶
func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope awscdk.Construct, id *string, props *CfnGraphQLSchemaProps)
Create a new `AWS::AppSync::GraphQLSchema`.
func NewCfnResolver_Override ¶
func NewCfnResolver_Override(c CfnResolver, scope awscdk.Construct, id *string, props *CfnResolverProps)
Create a new `AWS::AppSync::Resolver`.
func NewDynamoDbDataSource_Override ¶
func NewDynamoDbDataSource_Override(d DynamoDbDataSource, scope constructs.Construct, id *string, props *DynamoDbDataSourceProps)
Experimental.
func NewElasticsearchDataSource_Override ¶
func NewElasticsearchDataSource_Override(e ElasticsearchDataSource, scope constructs.Construct, id *string, props *ElasticsearchDataSourceProps)
Experimental.
func NewEnumType_Override ¶
func NewEnumType_Override(e EnumType, name *string, options *EnumTypeOptions)
Experimental.
func NewGraphqlApiBase_Override ¶
func NewGraphqlApiBase_Override(g GraphqlApiBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
Experimental.
func NewGraphqlApi_Override ¶
func NewGraphqlApi_Override(g GraphqlApi, scope constructs.Construct, id *string, props *GraphqlApiProps)
Experimental.
func NewGraphqlType_Override ¶
func NewGraphqlType_Override(g GraphqlType, type_ Type, options *GraphqlTypeOptions)
Experimental.
func NewHttpDataSource_Override ¶
func NewHttpDataSource_Override(h HttpDataSource, scope constructs.Construct, id *string, props *HttpDataSourceProps)
Experimental.
func NewInputType_Override ¶
func NewInputType_Override(i InputType, name *string, props *IntermediateTypeOptions)
Experimental.
func NewInterfaceType_Override ¶
func NewInterfaceType_Override(i InterfaceType, name *string, props *IntermediateTypeOptions)
Experimental.
func NewLambdaDataSource_Override ¶
func NewLambdaDataSource_Override(l LambdaDataSource, scope constructs.Construct, id *string, props *LambdaDataSourceProps)
Experimental.
func NewMappingTemplate_Override ¶
func NewMappingTemplate_Override(m MappingTemplate)
Experimental.
func NewNoneDataSource_Override ¶
func NewNoneDataSource_Override(n NoneDataSource, scope constructs.Construct, id *string, props *NoneDataSourceProps)
Experimental.
func NewObjectType_Override ¶
func NewObjectType_Override(o ObjectType, name *string, props *ObjectTypeOptions)
Experimental.
func NewPartitionKeyStep_Override ¶
func NewPartitionKeyStep_Override(p PartitionKeyStep, key *string)
Experimental.
func NewPartitionKey_Override ¶
func NewPartitionKey_Override(p PartitionKey, pkey Assign)
Experimental.
func NewPrimaryKey_Override ¶
func NewPrimaryKey_Override(p PrimaryKey, pkey Assign, skey Assign)
Experimental.
func NewRdsDataSource_Override ¶
func NewRdsDataSource_Override(r RdsDataSource, scope constructs.Construct, id *string, props *RdsDataSourceProps)
Experimental.
func NewResolvableField_Override ¶
func NewResolvableField_Override(r ResolvableField, options *ResolvableFieldOptions)
Experimental.
func NewResolver_Override ¶
func NewResolver_Override(r Resolver, scope constructs.Construct, id *string, props *ResolverProps)
Experimental.
func NewSortKeyStep_Override ¶
func NewSortKeyStep_Override(s SortKeyStep, pkey Assign, skey *string)
Experimental.
func NewUnionType_Override ¶
func NewUnionType_Override(u UnionType, name *string, options *UnionTypeOptions)
Experimental.
func NoneDataSource_IsConstruct ¶
func NoneDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func RdsDataSource_IsConstruct ¶
func RdsDataSource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func Resolver_IsConstruct ¶
func Resolver_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
Types ¶
type AddFieldOptions ¶
type AddFieldOptions struct { // The resolvable field to add. // // This option must be configured for Object, Interface, // Input and Union Types. // Experimental. Field IField `json:"field" yaml:"field"` // The name of the field. // // This option must be configured for Object, Interface, // Input and Enum Types. // Experimental. FieldName *string `json:"fieldName" yaml:"fieldName"` }
The options to add a field to an Intermediate Type.
TODO: EXAMPLE
Experimental.
type ApiKeyConfig ¶
type ApiKeyConfig struct { // Description of API key. // Experimental. Description *string `json:"description" yaml:"description"` // The time from creation time after which the API key expires. // // It must be a minimum of 1 day and a maximum of 365 days from date of creation. // Rounded down to the nearest hour. // Experimental. Expires awscdk.Expiration `json:"expires" yaml:"expires"` // Unique name of the API Key. // Experimental. Name *string `json:"name" yaml:"name"` }
Configuration for API Key authorization in AppSync.
TODO: EXAMPLE
Experimental.
type AppsyncFunction ¶
type AppsyncFunction interface { awscdk.Resource IAppsyncFunction DataSource() BaseDataSource Env() *awscdk.ResourceEnvironment FunctionArn() *string FunctionId() *string FunctionName() *string Node() awscdk.ConstructNode PhysicalName() *string Stack() awscdk.Stack ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
AppSync Functions are local functions that perform certain operations onto a backend data source.
Developers can compose operations (Functions) and execute them in sequence with Pipeline Resolvers.
TODO: EXAMPLE
Experimental.
func NewAppsyncFunction ¶
func NewAppsyncFunction(scope constructs.Construct, id *string, props *AppsyncFunctionProps) AppsyncFunction
Experimental.
type AppsyncFunctionAttributes ¶
type AppsyncFunctionAttributes struct { // the ARN of the AppSync function. // Experimental. FunctionArn *string `json:"functionArn" yaml:"functionArn"` }
The attributes for imported AppSync Functions.
TODO: EXAMPLE
Experimental.
type AppsyncFunctionProps ¶
type AppsyncFunctionProps struct { // the name of the AppSync Function. // Experimental. Name *string `json:"name" yaml:"name"` // the description for this AppSync Function. // Experimental. Description *string `json:"description" yaml:"description"` // the request mapping template for the AppSync Function. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // the response mapping template for the AppSync Function. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` // the GraphQL Api linked to this AppSync Function. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the data source linked to this AppSync Function. // Experimental. DataSource BaseDataSource `json:"dataSource" yaml:"dataSource"` }
the CDK properties for AppSync Functions.
TODO: EXAMPLE
Experimental.
type Assign ¶
Utility class representing the assigment of a value to an attribute.
TODO: EXAMPLE
Experimental.
type AttributeValues ¶
type AttributeValues interface { Attribute(attr *string) AttributeValuesStep RenderTemplate() *string RenderVariables() *string }
Specifies the attribute value assignments.
TODO: EXAMPLE
Experimental.
func NewAttributeValues ¶
func NewAttributeValues(container *string, assignments *[]Assign) AttributeValues
Experimental.
func Values_Projecting ¶
func Values_Projecting(arg *string) AttributeValues
Treats the specified object as a map of assignments, where the property names represent attribute names.
It’s opinionated about how it represents some of the nested objects: e.g., it will use lists (“L”) rather than sets (“SS”, “NS”, “BS”). By default it projects the argument container ("$ctx.args"). Experimental.
type AttributeValuesStep ¶
type AttributeValuesStep interface {
Is(val *string) AttributeValues
}
Utility class to allow assigning a value to an attribute.
TODO: EXAMPLE
Experimental.
func NewAttributeValuesStep ¶
func NewAttributeValuesStep(attr *string, container *string, assignments *[]Assign) AttributeValuesStep
Experimental.
func Values_Attribute ¶
func Values_Attribute(attr *string) AttributeValuesStep
Allows assigning a value to the specified attribute. Experimental.
type AuthorizationConfig ¶
type AuthorizationConfig struct { // Additional authorization modes. // Experimental. AdditionalAuthorizationModes *[]*AuthorizationMode `json:"additionalAuthorizationModes" yaml:"additionalAuthorizationModes"` // Optional authorization configuration. // Experimental. DefaultAuthorization *AuthorizationMode `json:"defaultAuthorization" yaml:"defaultAuthorization"` }
Configuration of the API authorization modes.
TODO: EXAMPLE
Experimental.
type AuthorizationMode ¶
type AuthorizationMode struct { // One of possible four values AppSync supports. // See: https://docs.aws.amazon.com/appsync/latest/devguide/security.html // // Experimental. AuthorizationType AuthorizationType `json:"authorizationType" yaml:"authorizationType"` // If authorizationType is `AuthorizationType.API_KEY`, this option can be configured. // Experimental. ApiKeyConfig *ApiKeyConfig `json:"apiKeyConfig" yaml:"apiKeyConfig"` // If authorizationType is `AuthorizationType.LAMBDA`, this option is required. // Experimental. LambdaAuthorizerConfig *LambdaAuthorizerConfig `json:"lambdaAuthorizerConfig" yaml:"lambdaAuthorizerConfig"` // If authorizationType is `AuthorizationType.OIDC`, this option is required. // Experimental. OpenIdConnectConfig *OpenIdConnectConfig `json:"openIdConnectConfig" yaml:"openIdConnectConfig"` // If authorizationType is `AuthorizationType.USER_POOL`, this option is required. // Experimental. UserPoolConfig *UserPoolConfig `json:"userPoolConfig" yaml:"userPoolConfig"` }
Interface to specify default or additional authorization(s).
TODO: EXAMPLE
Experimental.
type AuthorizationType ¶
type AuthorizationType string
enum with all possible values for AppSync authorization type.
TODO: EXAMPLE
Experimental.
const ( AuthorizationType_API_KEY AuthorizationType = "API_KEY" AuthorizationType_IAM AuthorizationType = "IAM" AuthorizationType_USER_POOL AuthorizationType = "USER_POOL" AuthorizationType_OIDC AuthorizationType = "OIDC" AuthorizationType_LAMBDA AuthorizationType = "LAMBDA" )
type AwsIamConfig ¶
type AwsIamConfig struct { // The signing region for AWS IAM authorization. // Experimental. SigningRegion *string `json:"signingRegion" yaml:"signingRegion"` // The signing service name for AWS IAM authorization. // Experimental. SigningServiceName *string `json:"signingServiceName" yaml:"signingServiceName"` }
The authorization config in case the HTTP endpoint requires authorization.
TODO: EXAMPLE
Experimental.
type BackedDataSource ¶
type BackedDataSource interface { BaseDataSource awsiam.IGrantable Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
Abstract AppSync datasource implementation.
Do not use directly but use subclasses for resource backed datasources Experimental.
type BackedDataSourceProps ¶
type BackedDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The IAM service role to be assumed by AppSync to interact with the data source. // Experimental. ServiceRole awsiam.IRole `json:"serviceRole" yaml:"serviceRole"` }
properties for an AppSync datasource backed by a resource.
TODO: EXAMPLE
Experimental.
type BaseAppsyncFunctionProps ¶
type BaseAppsyncFunctionProps struct { // the name of the AppSync Function. // Experimental. Name *string `json:"name" yaml:"name"` // the description for this AppSync Function. // Experimental. Description *string `json:"description" yaml:"description"` // the request mapping template for the AppSync Function. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // the response mapping template for the AppSync Function. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` }
the base properties for AppSync Functions.
TODO: EXAMPLE
Experimental.
type BaseDataSource ¶
type BaseDataSource interface { awscdk.Construct Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
Abstract AppSync datasource implementation.
Do not use directly but use subclasses for concrete datasources ¶
TODO: EXAMPLE
Experimental.
type BaseDataSourceProps ¶
type BaseDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` }
Base properties for an AppSync datasource.
TODO: EXAMPLE
Experimental.
type BaseResolverProps ¶
type BaseResolverProps struct { // name of the GraphQL field in the given type this resolver is attached to. // Experimental. FieldName *string `json:"fieldName" yaml:"fieldName"` // name of the GraphQL type this resolver is attached to. // Experimental. TypeName *string `json:"typeName" yaml:"typeName"` // The caching configuration for this resolver. // Experimental. CachingConfig *CachingConfig `json:"cachingConfig" yaml:"cachingConfig"` // configuration of the pipeline resolver. // Experimental. PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig" yaml:"pipelineConfig"` // The request mapping template for this resolver. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // The response mapping template for this resolver. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` }
Basic properties for an AppSync resolver.
TODO: EXAMPLE
Experimental.
type BaseTypeOptions ¶
type BaseTypeOptions struct { // property determining if this attribute is a list i.e. if true, attribute would be [Type]. // Experimental. IsList *bool `json:"isList" yaml:"isList"` // property determining if this attribute is non-nullable i.e. if true, attribute would be Type! // Experimental. IsRequired *bool `json:"isRequired" yaml:"isRequired"` // property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! or if isRequired true, attribe would be [ Type! ]! // Experimental. IsRequiredList *bool `json:"isRequiredList" yaml:"isRequiredList"` }
Base options for GraphQL Types.
TODO: EXAMPLE
Experimental.
type CachingConfig ¶
type CachingConfig struct { // The TTL in seconds for a resolver that has caching enabled. // // Valid values are between 1 and 3600 seconds. // Experimental. Ttl awscdk.Duration `json:"ttl" yaml:"ttl"` // The caching keys for a resolver that has caching enabled. // // Valid values are entries from the $context.arguments, $context.source, and $context.identity maps. // Experimental. CachingKeys *[]*string `json:"cachingKeys" yaml:"cachingKeys"` }
CachingConfig for AppSync resolvers.
TODO: EXAMPLE
Experimental.
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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"apiCachingBehavior"` // The GraphQL API ID. ApiId *string `json:"apiId" yaml:"apiId"` // TTL in seconds for cache entries. // // Valid values are 1–3,600 seconds. Ttl *float64 `json:"ttl" yaml:"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" yaml:"type"` // At-rest encryption flag for cache. // // You cannot update this setting after creation. AtRestEncryptionEnabled interface{} `json:"atRestEncryptionEnabled" yaml:"atRestEncryptionEnabled"` // Transit encryption flag when connecting to cache. // // You cannot update this setting after creation. TransitEncryptionEnabled interface{} `json:"transitEncryptionEnabled" yaml:"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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"apiId"` // The API key ID. ApiKeyId *string `json:"apiKeyId" yaml:"apiKeyId"` // Unique description of your API key. Description *string `json:"description" yaml:"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" yaml:"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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"apiId"` // Friendly name for you to identify your AppSync data source after creation. Name *string `json:"name" yaml:"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" yaml:"type"` // The description of the data source. Description *string `json:"description" yaml:"description"` // AWS Region and TableName for an Amazon DynamoDB table in your account. DynamoDbConfig interface{} `json:"dynamoDbConfig" yaml:"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" yaml:"elasticsearchConfig"` // Endpoints for an HTTP data source. HttpConfig interface{} `json:"httpConfig" yaml:"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" yaml:"lambdaConfig"` // AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. OpenSearchServiceConfig interface{} `json:"openSearchServiceConfig" yaml:"openSearchServiceConfig"` // Relational Database configuration of the relational database data source. RelationalDatabaseConfig interface{} `json:"relationalDatabaseConfig" yaml:"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" yaml:"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" yaml:"authorizationType"` // The AWS Identity and Access Management settings. AwsIamConfig interface{} `json:"awsIamConfig" yaml:"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" yaml:"signingRegion"` // The signing service name for AWS Identity and Access Management authorization. SigningServiceName *string `json:"signingServiceName" yaml:"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" yaml:"baseTableTtl"` // The Delta Sync table name. DeltaSyncTableName *string `json:"deltaSyncTableName" yaml:"deltaSyncTableName"` // The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. DeltaSyncTableTtl *string `json:"deltaSyncTableTtl" yaml:"deltaSyncTableTtl"` }
Describes a Delta Sync configuration.
TODO: EXAMPLE
type CfnDataSource_DynamoDBConfigProperty ¶
type CfnDataSource_DynamoDBConfigProperty struct { // The AWS Region. AwsRegion *string `json:"awsRegion" yaml:"awsRegion"` // The table name. TableName *string `json:"tableName" yaml:"tableName"` // The `DeltaSyncConfig` for a versioned datasource. DeltaSyncConfig interface{} `json:"deltaSyncConfig" yaml:"deltaSyncConfig"` // Set to `TRUE` to use AWS Identity and Access Management with this data source. UseCallerCredentials interface{} `json:"useCallerCredentials" yaml:"useCallerCredentials"` // Set to TRUE to use Conflict Detection and Resolution with this data source. Versioned interface{} `json:"versioned" yaml:"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" yaml:"awsRegion"` // The endpoint. Endpoint *string `json:"endpoint" yaml:"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" yaml:"endpoint"` // The authorization configuration. AuthorizationConfig interface{} `json:"authorizationConfig" yaml:"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" yaml:"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" yaml:"awsRegion"` // The endpoint. Endpoint *string `json:"endpoint" yaml:"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" yaml:"awsRegion"` // The ARN for database credentials stored in AWS Secrets Manager . AwsSecretStoreArn *string `json:"awsSecretStoreArn" yaml:"awsSecretStoreArn"` // Amazon RDS cluster Amazon Resource Name (ARN). DbClusterIdentifier *string `json:"dbClusterIdentifier" yaml:"dbClusterIdentifier"` // Logical database name. DatabaseName *string `json:"databaseName" yaml:"databaseName"` // Logical schema name. Schema *string `json:"schema" yaml:"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" yaml:"relationalDatabaseSourceType"` // Information about the Amazon RDS resource. RdsHttpEndpointConfig interface{} `json:"rdsHttpEndpointConfig" yaml:"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 ¶
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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 ¶
func NewCfnDomainName(scope awscdk.Construct, id *string, props *CfnDomainNameProps) CfnDomainName
Create a new `AWS::AppSync::DomainName`.
type CfnDomainNameApiAssociation ¶
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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 ¶
func NewCfnDomainNameApiAssociation(scope awscdk.Construct, id *string, props *CfnDomainNameApiAssociationProps) CfnDomainNameApiAssociation
Create a new `AWS::AppSync::DomainNameApiAssociation`.
type CfnDomainNameApiAssociationProps ¶
type CfnDomainNameApiAssociationProps struct { // The API ID. ApiId *string `json:"apiId" yaml:"apiId"` // The domain name. DomainName *string `json:"domainName" yaml:"domainName"` }
Properties for defining a `CfnDomainNameApiAssociation`.
TODO: EXAMPLE
type CfnDomainNameProps ¶
type CfnDomainNameProps struct { // The Amazon Resource Name (ARN) of the certificate. // // This will be an AWS Certificate Manager certificate. CertificateArn *string `json:"certificateArn" yaml:"certificateArn"` // The domain name. DomainName *string `json:"domainName" yaml:"domainName"` // The decription for your domain name. Description *string `json:"description" yaml:"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 MaxBatchSize() *float64 SetMaxBatchSize(val *float64) Name() *string SetName(val *string) Node() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"apiId"` // The name of data source this function will attach. DataSourceName *string `json:"dataSourceName" yaml:"dataSourceName"` // The version of the request mapping template. // // Currently, only the 2018-05-29 version of the template is supported. FunctionVersion *string `json:"functionVersion" yaml:"functionVersion"` // The name of the function. Name *string `json:"name" yaml:"name"` // The `Function` description. Description *string `json:"description" yaml:"description"` // The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation. MaxBatchSize *float64 `json:"maxBatchSize" yaml:"maxBatchSize"` // The `Function` request mapping template. // // Functions support only the 2018-05-29 version of the request mapping template. RequestMappingTemplate *string `json:"requestMappingTemplate" yaml:"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" yaml:"requestMappingTemplateS3Location"` // The `Function` response mapping template. ResponseMappingTemplate *string `json:"responseMappingTemplate" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"conflictHandler"` // The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler. LambdaConflictHandlerConfig interface{} `json:"lambdaConflictHandlerConfig" yaml:"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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"authenticationType"` // The API name. Name *string `json:"name" yaml:"name"` // A list of additional authentication providers for the `GraphqlApi` API. AdditionalAuthenticationProviders interface{} `json:"additionalAuthenticationProviders" yaml:"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" yaml:"lambdaAuthorizerConfig"` // The Amazon CloudWatch Logs configuration. LogConfig interface{} `json:"logConfig" yaml:"logConfig"` // The OpenID Connect configuration. OpenIdConnectConfig interface{} `json:"openIdConnectConfig" yaml:"openIdConnectConfig"` // An arbitrary set of tags (key-value pairs) for this GraphQL API. Tags interface{} `json:"tags" yaml:"tags"` // Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. UserPoolConfig interface{} `json:"userPoolConfig" yaml:"userPoolConfig"` // A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` . XrayEnabled interface{} `json:"xrayEnabled" yaml:"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" yaml:"authenticationType"` // Configuration for AWS Lambda function authorization. LambdaAuthorizerConfig interface{} `json:"lambdaAuthorizerConfig" yaml:"lambdaAuthorizerConfig"` // The OIDC configuration. OpenIdConnectConfig interface{} `json:"openIdConnectConfig" yaml:"openIdConnectConfig"` // The Amazon Cognito user pool configuration. UserPoolConfig interface{} `json:"userPoolConfig" yaml:"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" yaml:"appIdClientRegex"` // The AWS Region in which the user pool was created. AwsRegion *string `json:"awsRegion" yaml:"awsRegion"` // The user pool ID. UserPoolId *string `json:"userPoolId" yaml:"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" yaml:"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" yaml:"authorizerUri"` // A regular expression for validation of tokens before the Lambda function is called. IdentityValidationExpression *string `json:"identityValidationExpression" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"clientId"` // The number of milliseconds that a token is valid after it's issued to a user. IatTtl *float64 `json:"iatTtl" yaml:"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" yaml:"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" yaml:"appIdClientRegex"` // The AWS Region in which the user pool was created. AwsRegion *string `json:"awsRegion" yaml:"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" yaml:"defaultAction"` // The user pool ID. UserPoolId *string `json:"userPoolId" yaml:"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() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"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" yaml:"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" yaml:"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 MaxBatchSize() *float64 SetMaxBatchSize(val *float64) Node() awscdk.ConstructNode 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) OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string OverrideLogicalId(newLogicalId *string) Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*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 awscdk.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" yaml:"apiId"` // The GraphQL field on a type that invokes the resolver. FieldName *string `json:"fieldName" yaml:"fieldName"` // The GraphQL type that invokes this resolver. TypeName *string `json:"typeName" yaml:"typeName"` // The caching configuration for the resolver. CachingConfig interface{} `json:"cachingConfig" yaml:"cachingConfig"` // The resolver data source name. DataSourceName *string `json:"dataSourceName" yaml:"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" yaml:"kind"` // The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation. MaxBatchSize *float64 `json:"maxBatchSize" yaml:"maxBatchSize"` // Functions linked with the pipeline resolver. PipelineConfig interface{} `json:"pipelineConfig" yaml:"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" yaml:"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" yaml:"requestMappingTemplateS3Location"` // The response mapping template. ResponseMappingTemplate *string `json:"responseMappingTemplate" yaml:"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" yaml:"responseMappingTemplateS3Location"` // The `SyncConfig` for a resolver attached to a versioned data source. SyncConfig interface{} `json:"syncConfig" yaml:"syncConfig"` }
Properties for defining a `CfnResolver`.
TODO: EXAMPLE
type CfnResolver_CachingConfigProperty ¶
type CfnResolver_CachingConfigProperty struct { // The TTL in seconds for a resolver that has caching activated. // // Valid values are 1–3,600 seconds. Ttl *float64 `json:"ttl" yaml:"ttl"` // 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" yaml:"cachingKeys"` }
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" yaml:"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" yaml:"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" yaml:"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" yaml:"conflictHandler"` // The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler. LambdaConflictHandlerConfig interface{} `json:"lambdaConflictHandlerConfig" yaml:"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 DataSourceOptions ¶
type DataSourceOptions struct { // The description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source, overrides the id given by cdk. // Experimental. Name *string `json:"name" yaml:"name"` }
Optional configuration for data sources.
TODO: EXAMPLE
Experimental.
type Directive ¶
type Directive interface { Mode() AuthorizationType Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) MutationFields() *[]*string ToString() *string }
Directives for types.
i.e. @aws_iam or @aws_subscribe
TODO: EXAMPLE
Experimental.
func Directive_ApiKey ¶
func Directive_ApiKey() Directive
Add the @aws_api_key directive. Experimental.
func Directive_Cognito ¶
Add the @aws_auth or @aws_cognito_user_pools directive. Experimental.
func Directive_Custom ¶
Add a custom directive. Experimental.
func Directive_Subscribe ¶
Add the @aws_subscribe directive.
Only use for top level Subscription type. Experimental.
type DynamoDbDataSource ¶
type DynamoDbDataSource interface { BackedDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync datasource backed by a DynamoDB table.
TODO: EXAMPLE
Experimental.
func NewDynamoDbDataSource ¶
func NewDynamoDbDataSource(scope constructs.Construct, id *string, props *DynamoDbDataSourceProps) DynamoDbDataSource
Experimental.
type DynamoDbDataSourceProps ¶
type DynamoDbDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The IAM service role to be assumed by AppSync to interact with the data source. // Experimental. ServiceRole awsiam.IRole `json:"serviceRole" yaml:"serviceRole"` // The DynamoDB table backing this data source. // Experimental. Table awsdynamodb.ITable `json:"table" yaml:"table"` // Specify whether this DS is read only or has read and write permissions to the DynamoDB table. // Experimental. ReadOnlyAccess *bool `json:"readOnlyAccess" yaml:"readOnlyAccess"` // use credentials of caller to access DynamoDB. // Experimental. UseCallerCredentials *bool `json:"useCallerCredentials" yaml:"useCallerCredentials"` }
Properties for an AppSync DynamoDB datasource.
TODO: EXAMPLE
Experimental.
type ElasticsearchDataSource ¶
type ElasticsearchDataSource interface { BackedDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An Appsync datasource backed by Elasticsearch.
TODO: EXAMPLE
Experimental.
func NewElasticsearchDataSource ¶
func NewElasticsearchDataSource(scope constructs.Construct, id *string, props *ElasticsearchDataSourceProps) ElasticsearchDataSource
Experimental.
type ElasticsearchDataSourceProps ¶
type ElasticsearchDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The IAM service role to be assumed by AppSync to interact with the data source. // Experimental. ServiceRole awsiam.IRole `json:"serviceRole" yaml:"serviceRole"` // The elasticsearch domain containing the endpoint for the data source. // Experimental. Domain awselasticsearch.IDomain `json:"domain" yaml:"domain"` }
Properities for the Elasticsearch Data Source.
TODO: EXAMPLE
Experimental.
type EnumType ¶
type EnumType interface { IIntermediateType Definition() *map[string]IField Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) Name() *string AddField(options *AddFieldOptions) Attribute(options *BaseTypeOptions) GraphqlType ToString() *string }
Enum Types are abstract types that includes a set of fields that represent the strings this type can create.
TODO: EXAMPLE
Experimental.
type EnumTypeOptions ¶
type EnumTypeOptions struct { // the attributes of this type. // Experimental. Definition *[]*string `json:"definition" yaml:"definition"` }
Properties for configuring an Enum Type.
TODO: EXAMPLE
Experimental.
type ExtendedDataSourceProps ¶
type ExtendedDataSourceProps struct { // the type of the AppSync datasource. // Experimental. Type *string `json:"type" yaml:"type"` // configuration for DynamoDB Datasource. // Experimental. DynamoDbConfig interface{} `json:"dynamoDbConfig" yaml:"dynamoDbConfig"` // configuration for Elasticsearch Datasource. // Experimental. ElasticsearchConfig interface{} `json:"elasticsearchConfig" yaml:"elasticsearchConfig"` // configuration for HTTP Datasource. // Experimental. HttpConfig interface{} `json:"httpConfig" yaml:"httpConfig"` // configuration for Lambda Datasource. // Experimental. LambdaConfig interface{} `json:"lambdaConfig" yaml:"lambdaConfig"` // configuration for RDS Datasource. // Experimental. RelationalDatabaseConfig interface{} `json:"relationalDatabaseConfig" yaml:"relationalDatabaseConfig"` }
props used by implementations of BaseDataSource to provide configuration.
Should not be used directly.
TODO: EXAMPLE
Experimental.
type ExtendedResolverProps ¶
type ExtendedResolverProps struct { // name of the GraphQL field in the given type this resolver is attached to. // Experimental. FieldName *string `json:"fieldName" yaml:"fieldName"` // name of the GraphQL type this resolver is attached to. // Experimental. TypeName *string `json:"typeName" yaml:"typeName"` // The caching configuration for this resolver. // Experimental. CachingConfig *CachingConfig `json:"cachingConfig" yaml:"cachingConfig"` // configuration of the pipeline resolver. // Experimental. PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig" yaml:"pipelineConfig"` // The request mapping template for this resolver. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // The response mapping template for this resolver. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` // The data source this resolver is using. // Experimental. DataSource BaseDataSource `json:"dataSource" yaml:"dataSource"` }
Additional property for an AppSync resolver for data source reference.
TODO: EXAMPLE
Experimental.
type Field ¶
type Field interface { GraphqlType IField FieldOptions() *ResolvableFieldOptions IntermediateType() IIntermediateType IsList() *bool IsRequired() *bool IsRequiredList() *bool Type() Type ArgsToString() *string DirectivesToString(modes *[]AuthorizationType) *string ToString() *string }
Fields build upon Graphql Types and provide typing and arguments.
TODO: EXAMPLE
Experimental.
type FieldLogLevel ¶
type FieldLogLevel string
log-level for fields in AppSync. Experimental.
const ( FieldLogLevel_NONE FieldLogLevel = "NONE" FieldLogLevel_ERROR FieldLogLevel = "ERROR" FieldLogLevel_ALL FieldLogLevel = "ALL" )
type FieldOptions ¶
type FieldOptions struct { // The return type for this field. // Experimental. ReturnType GraphqlType `json:"returnType" yaml:"returnType"` // The arguments for this field. // // i.e. type Example (first: String second: String) {} // - where 'first' and 'second' are key values for args // and 'String' is the GraphqlType // Experimental. Args *map[string]GraphqlType `json:"args" yaml:"args"` // the directives for this field. // Experimental. Directives *[]Directive `json:"directives" yaml:"directives"` }
Properties for configuring a field.
TODO: EXAMPLE
Experimental.
type GraphqlApi ¶
type GraphqlApi interface { GraphqlApiBase ApiId() *string ApiKey() *string Arn() *string Env() *awscdk.ResourceEnvironment GraphqlUrl() *string Modes() *[]AuthorizationType Name() *string Node() awscdk.ConstructNode PhysicalName() *string Schema() Schema Stack() awscdk.Stack AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource AddMutation(fieldName *string, field ResolvableField) ObjectType AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource AddQuery(fieldName *string, field ResolvableField) ObjectType AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource AddSchemaDependency(construct awscdk.CfnResource) *bool AddSubscription(fieldName *string, field ResolvableField) ObjectType AddToSchema(addition *string, delimiter *string) AddType(type_ IIntermediateType) IIntermediateType ApplyRemovalPolicy(policy awscdk.RemovalPolicy) CreateResolver(props *ExtendedResolverProps) Resolver GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string Grant(grantee awsiam.IGrantable, resources IamResource, actions ...*string) awsiam.Grant GrantMutation(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant GrantQuery(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant GrantSubscription(grantee awsiam.IGrantable, fields ...*string) awsiam.Grant OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync GraphQL API.
TODO: EXAMPLE
Experimental.
func NewGraphqlApi ¶
func NewGraphqlApi(scope constructs.Construct, id *string, props *GraphqlApiProps) GraphqlApi
Experimental.
type GraphqlApiAttributes ¶
type GraphqlApiAttributes struct { // an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'. // Experimental. GraphqlApiId *string `json:"graphqlApiId" yaml:"graphqlApiId"` // the arn for the GraphQL Api. // Experimental. GraphqlApiArn *string `json:"graphqlApiArn" yaml:"graphqlApiArn"` }
Attributes for GraphQL imports.
TODO: EXAMPLE
Experimental.
type GraphqlApiBase ¶
type GraphqlApiBase interface { awscdk.Resource IGraphqlApi ApiId() *string Arn() *string Env() *awscdk.ResourceEnvironment Node() awscdk.ConstructNode PhysicalName() *string Stack() awscdk.Stack AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource AddSchemaDependency(construct awscdk.CfnResource) *bool ApplyRemovalPolicy(policy awscdk.RemovalPolicy) CreateResolver(props *ExtendedResolverProps) Resolver GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
Base Class for GraphQL API. Experimental.
type GraphqlApiProps ¶
type GraphqlApiProps struct { // the name of the GraphQL API. // Experimental. Name *string `json:"name" yaml:"name"` // Optional authorization configuration. // Experimental. AuthorizationConfig *AuthorizationConfig `json:"authorizationConfig" yaml:"authorizationConfig"` // Logging configuration for this api. // Experimental. LogConfig *LogConfig `json:"logConfig" yaml:"logConfig"` // GraphQL schema definition. Specify how you want to define your schema. // // Schema.fromFile(filePath: string) allows schema definition through schema.graphql file // Experimental. Schema Schema `json:"schema" yaml:"schema"` // A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API. // Experimental. XrayEnabled *bool `json:"xrayEnabled" yaml:"xrayEnabled"` }
Properties for an AppSync GraphQL API.
TODO: EXAMPLE
Experimental.
type GraphqlType ¶
type GraphqlType interface { IField IntermediateType() IIntermediateType IsList() *bool IsRequired() *bool IsRequiredList() *bool Type() Type ArgsToString() *string DirectivesToString(_modes *[]AuthorizationType) *string ToString() *string }
The GraphQL Types in AppSync's GraphQL.
GraphQL Types are the building blocks for object types, queries, mutations, etc. They are types like String, Int, Id or even Object Types you create.
i.e. `String`, `String!`, `[String]`, `[String!]`, `[String]!`
GraphQL Types are used to define the entirety of schema.
TODO: EXAMPLE
Experimental.
func Field_AwsDate ¶
func Field_AwsDate(options *BaseTypeOptions) GraphqlType
`AWSDate` scalar type represents a valid extended `ISO 8601 Date` string.
In other words, accepts date strings in the form of `YYYY-MM-DD`. It accepts time zone offsets. Experimental.
func Field_AwsDateTime ¶
func Field_AwsDateTime(options *BaseTypeOptions) GraphqlType
`AWSDateTime` scalar type represents a valid extended `ISO 8601 DateTime` string.
In other words, accepts date strings in the form of `YYYY-MM-DDThh:mm:ss.sssZ`. It accepts time zone offsets. Experimental.
func Field_AwsEmail ¶
func Field_AwsEmail(options *BaseTypeOptions) GraphqlType
`AWSEmail` scalar type represents an email address string (i.e.`username@example.com`). Experimental.
func Field_AwsIpAddress ¶
func Field_AwsIpAddress(options *BaseTypeOptions) GraphqlType
`AWSIPAddress` scalar type respresents a valid `IPv4` of `IPv6` address string. Experimental.
func Field_AwsJson ¶
func Field_AwsJson(options *BaseTypeOptions) GraphqlType
`AWSJson` scalar type represents a JSON string. Experimental.
func Field_AwsPhone ¶
func Field_AwsPhone(options *BaseTypeOptions) GraphqlType
`AWSPhone` scalar type represents a valid phone number. Phone numbers maybe be whitespace delimited or hyphenated.
The number can specify a country code at the beginning, but is not required for US phone numbers. Experimental.
func Field_AwsTime ¶
func Field_AwsTime(options *BaseTypeOptions) GraphqlType
`AWSTime` scalar type represents a valid extended `ISO 8601 Time` string.
In other words, accepts date strings in the form of `hh:mm:ss.sss`. It accepts time zone offsets. Experimental.
func Field_AwsTimestamp ¶
func Field_AwsTimestamp(options *BaseTypeOptions) GraphqlType
`AWSTimestamp` scalar type represents the number of seconds since `1970-01-01T00:00Z`.
Timestamps are serialized and deserialized as numbers. Experimental.
func Field_AwsUrl ¶
func Field_AwsUrl(options *BaseTypeOptions) GraphqlType
`AWSURL` scalar type represetns a valid URL string.
URLs wihtout schemes or contain double slashes are considered invalid. Experimental.
func Field_Boolean ¶
func Field_Boolean(options *BaseTypeOptions) GraphqlType
`Boolean` scalar type is a boolean value: true or false. Experimental.
func Field_Float ¶
func Field_Float(options *BaseTypeOptions) GraphqlType
`Float` scalar type is a signed double-precision fractional value. Experimental.
func Field_Id ¶
func Field_Id(options *BaseTypeOptions) GraphqlType
`ID` scalar type is a unique identifier. `ID` type is serialized similar to `String`.
Often used as a key for a cache and not intended to be human-readable. Experimental.
func Field_Int ¶
func Field_Int(options *BaseTypeOptions) GraphqlType
`Int` scalar type is a signed non-fractional numerical value. Experimental.
func Field_Intermediate ¶
func Field_Intermediate(options *GraphqlTypeOptions) GraphqlType
an intermediate type to be added as an attribute (i.e. an interface or an object type). Experimental.
func Field_String ¶
func Field_String(options *BaseTypeOptions) GraphqlType
`String` scalar type is a free-form human-readable text. Experimental.
func GraphqlType_AwsDate ¶
func GraphqlType_AwsDate(options *BaseTypeOptions) GraphqlType
`AWSDate` scalar type represents a valid extended `ISO 8601 Date` string.
In other words, accepts date strings in the form of `YYYY-MM-DD`. It accepts time zone offsets. Experimental.
func GraphqlType_AwsDateTime ¶
func GraphqlType_AwsDateTime(options *BaseTypeOptions) GraphqlType
`AWSDateTime` scalar type represents a valid extended `ISO 8601 DateTime` string.
In other words, accepts date strings in the form of `YYYY-MM-DDThh:mm:ss.sssZ`. It accepts time zone offsets. Experimental.
func GraphqlType_AwsEmail ¶
func GraphqlType_AwsEmail(options *BaseTypeOptions) GraphqlType
`AWSEmail` scalar type represents an email address string (i.e.`username@example.com`). Experimental.
func GraphqlType_AwsIpAddress ¶
func GraphqlType_AwsIpAddress(options *BaseTypeOptions) GraphqlType
`AWSIPAddress` scalar type respresents a valid `IPv4` of `IPv6` address string. Experimental.
func GraphqlType_AwsJson ¶
func GraphqlType_AwsJson(options *BaseTypeOptions) GraphqlType
`AWSJson` scalar type represents a JSON string. Experimental.
func GraphqlType_AwsPhone ¶
func GraphqlType_AwsPhone(options *BaseTypeOptions) GraphqlType
`AWSPhone` scalar type represents a valid phone number. Phone numbers maybe be whitespace delimited or hyphenated.
The number can specify a country code at the beginning, but is not required for US phone numbers. Experimental.
func GraphqlType_AwsTime ¶
func GraphqlType_AwsTime(options *BaseTypeOptions) GraphqlType
`AWSTime` scalar type represents a valid extended `ISO 8601 Time` string.
In other words, accepts date strings in the form of `hh:mm:ss.sss`. It accepts time zone offsets. Experimental.
func GraphqlType_AwsTimestamp ¶
func GraphqlType_AwsTimestamp(options *BaseTypeOptions) GraphqlType
`AWSTimestamp` scalar type represents the number of seconds since `1970-01-01T00:00Z`.
Timestamps are serialized and deserialized as numbers. Experimental.
func GraphqlType_AwsUrl ¶
func GraphqlType_AwsUrl(options *BaseTypeOptions) GraphqlType
`AWSURL` scalar type represetns a valid URL string.
URLs wihtout schemes or contain double slashes are considered invalid. Experimental.
func GraphqlType_Boolean ¶
func GraphqlType_Boolean(options *BaseTypeOptions) GraphqlType
`Boolean` scalar type is a boolean value: true or false. Experimental.
func GraphqlType_Float ¶
func GraphqlType_Float(options *BaseTypeOptions) GraphqlType
`Float` scalar type is a signed double-precision fractional value. Experimental.
func GraphqlType_Id ¶
func GraphqlType_Id(options *BaseTypeOptions) GraphqlType
`ID` scalar type is a unique identifier. `ID` type is serialized similar to `String`.
Often used as a key for a cache and not intended to be human-readable. Experimental.
func GraphqlType_Int ¶
func GraphqlType_Int(options *BaseTypeOptions) GraphqlType
`Int` scalar type is a signed non-fractional numerical value. Experimental.
func GraphqlType_Intermediate ¶
func GraphqlType_Intermediate(options *GraphqlTypeOptions) GraphqlType
an intermediate type to be added as an attribute (i.e. an interface or an object type). Experimental.
func GraphqlType_String ¶
func GraphqlType_String(options *BaseTypeOptions) GraphqlType
`String` scalar type is a free-form human-readable text. Experimental.
func NewGraphqlType ¶
func NewGraphqlType(type_ Type, options *GraphqlTypeOptions) GraphqlType
Experimental.
func ResolvableField_AwsDate ¶
func ResolvableField_AwsDate(options *BaseTypeOptions) GraphqlType
`AWSDate` scalar type represents a valid extended `ISO 8601 Date` string.
In other words, accepts date strings in the form of `YYYY-MM-DD`. It accepts time zone offsets. Experimental.
func ResolvableField_AwsDateTime ¶
func ResolvableField_AwsDateTime(options *BaseTypeOptions) GraphqlType
`AWSDateTime` scalar type represents a valid extended `ISO 8601 DateTime` string.
In other words, accepts date strings in the form of `YYYY-MM-DDThh:mm:ss.sssZ`. It accepts time zone offsets. Experimental.
func ResolvableField_AwsEmail ¶
func ResolvableField_AwsEmail(options *BaseTypeOptions) GraphqlType
`AWSEmail` scalar type represents an email address string (i.e.`username@example.com`). Experimental.
func ResolvableField_AwsIpAddress ¶
func ResolvableField_AwsIpAddress(options *BaseTypeOptions) GraphqlType
`AWSIPAddress` scalar type respresents a valid `IPv4` of `IPv6` address string. Experimental.
func ResolvableField_AwsJson ¶
func ResolvableField_AwsJson(options *BaseTypeOptions) GraphqlType
`AWSJson` scalar type represents a JSON string. Experimental.
func ResolvableField_AwsPhone ¶
func ResolvableField_AwsPhone(options *BaseTypeOptions) GraphqlType
`AWSPhone` scalar type represents a valid phone number. Phone numbers maybe be whitespace delimited or hyphenated.
The number can specify a country code at the beginning, but is not required for US phone numbers. Experimental.
func ResolvableField_AwsTime ¶
func ResolvableField_AwsTime(options *BaseTypeOptions) GraphqlType
`AWSTime` scalar type represents a valid extended `ISO 8601 Time` string.
In other words, accepts date strings in the form of `hh:mm:ss.sss`. It accepts time zone offsets. Experimental.
func ResolvableField_AwsTimestamp ¶
func ResolvableField_AwsTimestamp(options *BaseTypeOptions) GraphqlType
`AWSTimestamp` scalar type represents the number of seconds since `1970-01-01T00:00Z`.
Timestamps are serialized and deserialized as numbers. Experimental.
func ResolvableField_AwsUrl ¶
func ResolvableField_AwsUrl(options *BaseTypeOptions) GraphqlType
`AWSURL` scalar type represetns a valid URL string.
URLs wihtout schemes or contain double slashes are considered invalid. Experimental.
func ResolvableField_Boolean ¶
func ResolvableField_Boolean(options *BaseTypeOptions) GraphqlType
`Boolean` scalar type is a boolean value: true or false. Experimental.
func ResolvableField_Float ¶
func ResolvableField_Float(options *BaseTypeOptions) GraphqlType
`Float` scalar type is a signed double-precision fractional value. Experimental.
func ResolvableField_Id ¶
func ResolvableField_Id(options *BaseTypeOptions) GraphqlType
`ID` scalar type is a unique identifier. `ID` type is serialized similar to `String`.
Often used as a key for a cache and not intended to be human-readable. Experimental.
func ResolvableField_Int ¶
func ResolvableField_Int(options *BaseTypeOptions) GraphqlType
`Int` scalar type is a signed non-fractional numerical value. Experimental.
func ResolvableField_Intermediate ¶
func ResolvableField_Intermediate(options *GraphqlTypeOptions) GraphqlType
an intermediate type to be added as an attribute (i.e. an interface or an object type). Experimental.
func ResolvableField_String ¶
func ResolvableField_String(options *BaseTypeOptions) GraphqlType
`String` scalar type is a free-form human-readable text. Experimental.
type GraphqlTypeOptions ¶
type GraphqlTypeOptions struct { // property determining if this attribute is a list i.e. if true, attribute would be [Type]. // Experimental. IsList *bool `json:"isList" yaml:"isList"` // property determining if this attribute is non-nullable i.e. if true, attribute would be Type! // Experimental. IsRequired *bool `json:"isRequired" yaml:"isRequired"` // property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! or if isRequired true, attribe would be [ Type! ]! // Experimental. IsRequiredList *bool `json:"isRequiredList" yaml:"isRequiredList"` // the intermediate type linked to this attribute. // Experimental. IntermediateType IIntermediateType `json:"intermediateType" yaml:"intermediateType"` }
Options for GraphQL Types.
TODO: EXAMPLE
Experimental.
type HttpDataSource ¶
type HttpDataSource interface { BackedDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync datasource backed by a http endpoint.
TODO: EXAMPLE
Experimental.
func NewHttpDataSource ¶
func NewHttpDataSource(scope constructs.Construct, id *string, props *HttpDataSourceProps) HttpDataSource
Experimental.
type HttpDataSourceOptions ¶
type HttpDataSourceOptions struct { // The description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source, overrides the id given by cdk. // Experimental. Name *string `json:"name" yaml:"name"` // The authorization config in case the HTTP endpoint requires authorization. // Experimental. AuthorizationConfig *AwsIamConfig `json:"authorizationConfig" yaml:"authorizationConfig"` }
Optional configuration for Http data sources.
TODO: EXAMPLE
Experimental.
type HttpDataSourceProps ¶
type HttpDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The http endpoint. // Experimental. Endpoint *string `json:"endpoint" yaml:"endpoint"` // The authorization config in case the HTTP endpoint requires authorization. // Experimental. AuthorizationConfig *AwsIamConfig `json:"authorizationConfig" yaml:"authorizationConfig"` }
Properties for an AppSync http datasource.
TODO: EXAMPLE
Experimental.
type IAppsyncFunction ¶
type IAppsyncFunction interface { awscdk.IResource // the ARN of the AppSync function. // Experimental. FunctionArn() *string // the name of this AppSync Function. // Experimental. FunctionId() *string }
Interface for AppSync Functions. Experimental.
func AppsyncFunction_FromAppsyncFunctionAttributes ¶
func AppsyncFunction_FromAppsyncFunctionAttributes(scope constructs.Construct, id *string, attrs *AppsyncFunctionAttributes) IAppsyncFunction
Import Appsync Function from arn. Experimental.
type IField ¶
type IField interface { // Generate the arguments for this field. // Experimental. ArgsToString() *string // Generate the directives for this field. // Experimental. DirectivesToString(modes *[]AuthorizationType) *string // Generate the string for this attribute. // Experimental. ToString() *string // The options to make this field resolvable. // Experimental. FieldOptions() *ResolvableFieldOptions // the intermediate type linked to this attribute (i.e. an interface or an object). // Experimental. IntermediateType() IIntermediateType // property determining if this attribute is a list i.e. if true, attribute would be `[Type]`. // Experimental. IsList() *bool // property determining if this attribute is non-nullable i.e. if true, attribute would be `Type!` and this attribute must always have a value. // Experimental. IsRequired() *bool // property determining if this attribute is a non-nullable list i.e. if true, attribute would be `[ Type ]!` and this attribute's list must always have a value. // Experimental. IsRequiredList() *bool // the type of attribute. // Experimental. Type() Type }
A Graphql Field. Experimental.
type IGraphqlApi ¶
type IGraphqlApi interface { awscdk.IResource // add a new DynamoDB data source to this API. // Experimental. AddDynamoDbDataSource(id *string, table awsdynamodb.ITable, options *DataSourceOptions) DynamoDbDataSource // add a new elasticsearch data source to this API. // Experimental. AddElasticsearchDataSource(id *string, domain awselasticsearch.IDomain, options *DataSourceOptions) ElasticsearchDataSource // add a new http data source to this API. // Experimental. AddHttpDataSource(id *string, endpoint *string, options *HttpDataSourceOptions) HttpDataSource // add a new Lambda data source to this API. // Experimental. AddLambdaDataSource(id *string, lambdaFunction awslambda.IFunction, options *DataSourceOptions) LambdaDataSource // add a new dummy data source to this API. // // Useful for pipeline resolvers // and for backend changes that don't require a data source. // Experimental. AddNoneDataSource(id *string, options *DataSourceOptions) NoneDataSource // add a new Rds data source to this API. // Experimental. AddRdsDataSource(id *string, serverlessCluster awsrds.IServerlessCluster, secretStore awssecretsmanager.ISecret, databaseName *string, options *DataSourceOptions) RdsDataSource // Add schema dependency if not imported. // Experimental. AddSchemaDependency(construct awscdk.CfnResource) *bool // creates a new resolver for this datasource and API using the given properties. // Experimental. CreateResolver(props *ExtendedResolverProps) Resolver // an unique AWS AppSync GraphQL API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'. // Experimental. ApiId() *string // the ARN of the API. // Experimental. Arn() *string }
Interface for GraphQL. Experimental.
func GraphqlApi_FromGraphqlApiAttributes ¶
func GraphqlApi_FromGraphqlApiAttributes(scope constructs.Construct, id *string, attrs *GraphqlApiAttributes) IGraphqlApi
Import a GraphQL API through this function. Experimental.
type IIntermediateType ¶
type IIntermediateType interface { // Add a field to this Intermediate Type. // Experimental. AddField(options *AddFieldOptions) // Create an GraphQL Type representing this Intermediate Type. // Experimental. Attribute(options *BaseTypeOptions) GraphqlType // Generate the string of this object type. // Experimental. ToString() *string // the attributes of this type. // Experimental. Definition() *map[string]IField // the directives for this object type. // Experimental. Directives() *[]Directive // The Interface Types this Intermediate Type implements. // Experimental. InterfaceTypes() *[]InterfaceType // the intermediate type linked to this attribute (i.e. an interface or an object). // Experimental. IntermediateType() IIntermediateType // the name of this type. // Experimental. Name() *string // The resolvers linked to this data source. // Experimental. Resolvers() *[]Resolver // The resolvers linked to this data source. // Experimental. SetResolvers(r *[]Resolver) }
Intermediate Types are types that includes a certain set of fields that define the entirety of your schema. Experimental.
type IamResource ¶
type IamResource interface {
ResourceArns(api GraphqlApi) *[]*string
}
A class used to generate resource arns for AppSync.
TODO: EXAMPLE
Experimental.
func IamResource_All ¶
func IamResource_All() IamResource
Generate the resource names that accepts all types: `*`. Experimental.
func IamResource_Custom ¶
func IamResource_Custom(arns ...*string) IamResource
Generate the resource names given custom arns. Experimental.
func IamResource_OfType ¶
func IamResource_OfType(type_ *string, fields ...*string) IamResource
Generate the resource names given a type and fields. Experimental.
type InputType ¶
type InputType interface { IIntermediateType Definition() *map[string]IField Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) Name() *string AddField(options *AddFieldOptions) Attribute(options *BaseTypeOptions) GraphqlType ToString() *string }
Input Types are abstract types that define complex objects.
They are used in arguments to represent ¶
TODO: EXAMPLE
Experimental.
func NewInputType ¶
func NewInputType(name *string, props *IntermediateTypeOptions) InputType
Experimental.
type InterfaceType ¶
type InterfaceType interface { IIntermediateType Definition() *map[string]IField Directives() *[]Directive Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) Name() *string AddField(options *AddFieldOptions) Attribute(options *BaseTypeOptions) GraphqlType ToString() *string }
Interface Types are abstract types that includes a certain set of fields that other types must include if they implement the interface.
TODO: EXAMPLE
Experimental.
func NewInterfaceType ¶
func NewInterfaceType(name *string, props *IntermediateTypeOptions) InterfaceType
Experimental.
type IntermediateTypeOptions ¶
type IntermediateTypeOptions struct { // the attributes of this type. // Experimental. Definition *map[string]IField `json:"definition" yaml:"definition"` // the directives for this object type. // Experimental. Directives *[]Directive `json:"directives" yaml:"directives"` }
Properties for configuring an Intermediate Type.
TODO: EXAMPLE
Experimental.
type KeyCondition ¶
type KeyCondition interface { And(keyCond KeyCondition) KeyCondition RenderTemplate() *string }
Factory class for DynamoDB key conditions.
TODO: EXAMPLE
Experimental.
func KeyCondition_BeginsWith ¶
func KeyCondition_BeginsWith(keyName *string, arg *string) KeyCondition
Condition (k, arg).
True if the key attribute k begins with the Query argument. Experimental.
func KeyCondition_Between ¶
func KeyCondition_Between(keyName *string, arg1 *string, arg2 *string) KeyCondition
Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2. Experimental.
func KeyCondition_Eq ¶
func KeyCondition_Eq(keyName *string, arg *string) KeyCondition
Condition k = arg, true if the key attribute k is equal to the Query argument. Experimental.
func KeyCondition_Ge ¶
func KeyCondition_Ge(keyName *string, arg *string) KeyCondition
Condition k >= arg, true if the key attribute k is greater or equal to the Query argument. Experimental.
func KeyCondition_Gt ¶
func KeyCondition_Gt(keyName *string, arg *string) KeyCondition
Condition k > arg, true if the key attribute k is greater than the the Query argument. Experimental.
func KeyCondition_Le ¶
func KeyCondition_Le(keyName *string, arg *string) KeyCondition
Condition k <= arg, true if the key attribute k is less than or equal to the Query argument. Experimental.
func KeyCondition_Lt ¶
func KeyCondition_Lt(keyName *string, arg *string) KeyCondition
Condition k < arg, true if the key attribute k is less than the Query argument. Experimental.
type LambdaAuthorizerConfig ¶
type LambdaAuthorizerConfig struct { // The authorizer lambda function. // // 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` // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html // // Experimental. Handler awslambda.IFunction `json:"handler" yaml:"handler"` // How long the results are cached. // // Disable caching by setting this to 0. // Experimental. ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl" yaml:"resultsCacheTtl"` // A regular expression for validation of tokens before the Lambda function is called. // Experimental. ValidationRegex *string `json:"validationRegex" yaml:"validationRegex"` }
Configuration for Lambda authorization in AppSync.
Note that you can only have a single AWS Lambda function configured to authorize your API.
TODO: EXAMPLE
Experimental.
type LambdaDataSource ¶
type LambdaDataSource interface { BackedDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync datasource backed by a Lambda function.
TODO: EXAMPLE
Experimental.
func NewLambdaDataSource ¶
func NewLambdaDataSource(scope constructs.Construct, id *string, props *LambdaDataSourceProps) LambdaDataSource
Experimental.
type LambdaDataSourceProps ¶
type LambdaDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The IAM service role to be assumed by AppSync to interact with the data source. // Experimental. ServiceRole awsiam.IRole `json:"serviceRole" yaml:"serviceRole"` // The Lambda function to call to interact with this data source. // Experimental. LambdaFunction awslambda.IFunction `json:"lambdaFunction" yaml:"lambdaFunction"` }
Properties for an AppSync Lambda datasource.
TODO: EXAMPLE
Experimental.
type LogConfig ¶
type LogConfig struct { // exclude verbose content. // Experimental. ExcludeVerboseContent interface{} `json:"excludeVerboseContent" yaml:"excludeVerboseContent"` // log level for fields. // Experimental. FieldLogLevel FieldLogLevel `json:"fieldLogLevel" yaml:"fieldLogLevel"` // The role for CloudWatch Logs. // Experimental. Role awsiam.IRole `json:"role" yaml:"role"` }
Logging configuration for AppSync.
TODO: EXAMPLE
Experimental.
type MappingTemplate ¶
type MappingTemplate interface {
RenderTemplate() *string
}
MappingTemplates for AppSync resolvers.
TODO: EXAMPLE
Experimental.
func MappingTemplate_DynamoDbDeleteItem ¶
func MappingTemplate_DynamoDbDeleteItem(keyName *string, idArg *string) MappingTemplate
Mapping template to delete a single item from a DynamoDB table. Experimental.
func MappingTemplate_DynamoDbGetItem ¶
func MappingTemplate_DynamoDbGetItem(keyName *string, idArg *string) MappingTemplate
Mapping template to get a single item from a DynamoDB table. Experimental.
func MappingTemplate_DynamoDbPutItem ¶
func MappingTemplate_DynamoDbPutItem(key PrimaryKey, values AttributeValues) MappingTemplate
Mapping template to save a single item to a DynamoDB table. Experimental.
func MappingTemplate_DynamoDbQuery ¶
func MappingTemplate_DynamoDbQuery(cond KeyCondition, indexName *string) MappingTemplate
Mapping template to query a set of items from a DynamoDB table. Experimental.
func MappingTemplate_DynamoDbResultItem ¶
func MappingTemplate_DynamoDbResultItem() MappingTemplate
Mapping template for a single result item from DynamoDB. Experimental.
func MappingTemplate_DynamoDbResultList ¶
func MappingTemplate_DynamoDbResultList() MappingTemplate
Mapping template for a result list from DynamoDB. Experimental.
func MappingTemplate_DynamoDbScanTable ¶
func MappingTemplate_DynamoDbScanTable() MappingTemplate
Mapping template to scan a DynamoDB table to fetch all entries. Experimental.
func MappingTemplate_FromFile ¶
func MappingTemplate_FromFile(fileName *string) MappingTemplate
Create a mapping template from the given file. Experimental.
func MappingTemplate_FromString ¶
func MappingTemplate_FromString(template *string) MappingTemplate
Create a mapping template from the given string. Experimental.
func MappingTemplate_LambdaRequest ¶
func MappingTemplate_LambdaRequest(payload *string, operation *string) MappingTemplate
Mapping template to invoke a Lambda function. Experimental.
func MappingTemplate_LambdaResult ¶
func MappingTemplate_LambdaResult() MappingTemplate
Mapping template to return the Lambda result to the caller. Experimental.
type NoneDataSource ¶
type NoneDataSource interface { BaseDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync dummy datasource.
TODO: EXAMPLE
Experimental.
func NewNoneDataSource ¶
func NewNoneDataSource(scope constructs.Construct, id *string, props *NoneDataSourceProps) NoneDataSource
Experimental.
type NoneDataSourceProps ¶
type NoneDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` }
Properties for an AppSync dummy datasource.
TODO: EXAMPLE
Experimental.
type ObjectType ¶
type ObjectType interface { InterfaceType IIntermediateType Definition() *map[string]IField Directives() *[]Directive InterfaceTypes() *[]InterfaceType Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) Name() *string Resolvers() *[]Resolver SetResolvers(val *[]Resolver) AddField(options *AddFieldOptions) Attribute(options *BaseTypeOptions) GraphqlType GenerateResolver(api IGraphqlApi, fieldName *string, options *ResolvableFieldOptions) Resolver ToString() *string }
Object Types are types declared by you.
TODO: EXAMPLE
Experimental.
func NewObjectType ¶
func NewObjectType(name *string, props *ObjectTypeOptions) ObjectType
Experimental.
type ObjectTypeOptions ¶
type ObjectTypeOptions struct { // the attributes of this type. // Experimental. Definition *map[string]IField `json:"definition" yaml:"definition"` // the directives for this object type. // Experimental. Directives *[]Directive `json:"directives" yaml:"directives"` // The Interface Types this Object Type implements. // Experimental. InterfaceTypes *[]InterfaceType `json:"interfaceTypes" yaml:"interfaceTypes"` }
Properties for configuring an Object Type.
TODO: EXAMPLE
Experimental.
type OpenIdConnectConfig ¶
type OpenIdConnectConfig struct { // The issuer for the OIDC configuration. // // The issuer returned by discovery must exactly match the value of `iss` in the OIDC token. // Experimental. OidcProvider *string `json:"oidcProvider" yaml:"oidcProvider"` // The client identifier of the Relying party at the OpenID identity provider. // // A regular expression can be specified so AppSync can validate against multiple client identifiers at a time. // // TODO: EXAMPLE // // Experimental. ClientId *string `json:"clientId" yaml:"clientId"` // The number of milliseconds an OIDC token is valid after being authenticated by OIDC provider. // // `auth_time` claim in OIDC token is required for this validation to work. // Experimental. TokenExpiryFromAuth *float64 `json:"tokenExpiryFromAuth" yaml:"tokenExpiryFromAuth"` // The number of milliseconds an OIDC token is valid after being issued to a user. // // This validation uses `iat` claim of OIDC token. // Experimental. TokenExpiryFromIssue *float64 `json:"tokenExpiryFromIssue" yaml:"tokenExpiryFromIssue"` }
Configuration for OpenID Connect authorization in AppSync.
TODO: EXAMPLE
Experimental.
type PartitionKey ¶
type PartitionKey interface { PrimaryKey Pkey() Assign RenderTemplate() *string Sort(key *string) SortKeyStep }
Specifies the assignment to the partition key.
It can be enhanced with the assignment of the sort key.
TODO: EXAMPLE
Experimental.
type PartitionKeyStep ¶
type PartitionKeyStep interface { Auto() PartitionKey Is(val *string) PartitionKey }
Utility class to allow assigning a value or an auto-generated id to a partition key.
TODO: EXAMPLE
Experimental.
func PartitionKey_Partition ¶
func PartitionKey_Partition(key *string) PartitionKeyStep
Allows assigning a value to the partition key. Experimental.
func PrimaryKey_Partition ¶
func PrimaryKey_Partition(key *string) PartitionKeyStep
Allows assigning a value to the partition key. Experimental.
type PrimaryKey ¶
Specifies the assignment to the primary key.
It either contains the full primary key or only the partition key.
TODO: EXAMPLE
Experimental.
type RdsDataSource ¶
type RdsDataSource interface { BackedDataSource Api() IGraphqlApi SetApi(val IGraphqlApi) Ds() CfnDataSource GrantPrincipal() awsiam.IPrincipal Name() *string Node() awscdk.ConstructNode ServiceRole() awsiam.IRole SetServiceRole(val awsiam.IRole) CreateFunction(props *BaseAppsyncFunctionProps) AppsyncFunction CreateResolver(props *BaseResolverProps) Resolver OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync datasource backed by RDS.
TODO: EXAMPLE
Experimental.
func NewRdsDataSource ¶
func NewRdsDataSource(scope constructs.Construct, id *string, props *RdsDataSourceProps) RdsDataSource
Experimental.
type RdsDataSourceProps ¶
type RdsDataSourceProps struct { // The API to attach this data source to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` // the description of the data source. // Experimental. Description *string `json:"description" yaml:"description"` // The name of the data source. // Experimental. Name *string `json:"name" yaml:"name"` // The IAM service role to be assumed by AppSync to interact with the data source. // Experimental. ServiceRole awsiam.IRole `json:"serviceRole" yaml:"serviceRole"` // The secret containing the credentials for the database. // Experimental. SecretStore awssecretsmanager.ISecret `json:"secretStore" yaml:"secretStore"` // The serverless cluster to call to interact with this data source. // Experimental. ServerlessCluster awsrds.IServerlessCluster `json:"serverlessCluster" yaml:"serverlessCluster"` // The name of the database to use within the cluster. // Experimental. DatabaseName *string `json:"databaseName" yaml:"databaseName"` }
Properties for an AppSync RDS datasource.
TODO: EXAMPLE
Experimental.
type ResolvableField ¶
type ResolvableField interface { Field IField FieldOptions() *ResolvableFieldOptions IntermediateType() IIntermediateType IsList() *bool IsRequired() *bool IsRequiredList() *bool Type() Type ArgsToString() *string DirectivesToString(modes *[]AuthorizationType) *string ToString() *string }
Resolvable Fields build upon Graphql Types and provide fields that can resolve into operations on a data source.
TODO: EXAMPLE
Experimental.
func NewResolvableField ¶
func NewResolvableField(options *ResolvableFieldOptions) ResolvableField
Experimental.
type ResolvableFieldOptions ¶
type ResolvableFieldOptions struct { // The return type for this field. // Experimental. ReturnType GraphqlType `json:"returnType" yaml:"returnType"` // The arguments for this field. // // i.e. type Example (first: String second: String) {} // - where 'first' and 'second' are key values for args // and 'String' is the GraphqlType // Experimental. Args *map[string]GraphqlType `json:"args" yaml:"args"` // the directives for this field. // Experimental. Directives *[]Directive `json:"directives" yaml:"directives"` // The data source creating linked to this resolvable field. // Experimental. DataSource BaseDataSource `json:"dataSource" yaml:"dataSource"` // configuration of the pipeline resolver. // Experimental. PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig" yaml:"pipelineConfig"` // The request mapping template for this resolver. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // The response mapping template for this resolver. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` }
Properties for configuring a resolvable field.
TODO: EXAMPLE
Experimental.
type Resolver ¶
type Resolver interface { awscdk.Construct Arn() *string Node() awscdk.ConstructNode OnPrepare() OnSynthesize(session constructs.ISynthesisSession) OnValidate() *[]*string Prepare() Synthesize(session awscdk.ISynthesisSession) ToString() *string Validate() *[]*string }
An AppSync resolver.
TODO: EXAMPLE
Experimental.
func NewResolver ¶
func NewResolver(scope constructs.Construct, id *string, props *ResolverProps) Resolver
Experimental.
type ResolverProps ¶
type ResolverProps struct { // name of the GraphQL field in the given type this resolver is attached to. // Experimental. FieldName *string `json:"fieldName" yaml:"fieldName"` // name of the GraphQL type this resolver is attached to. // Experimental. TypeName *string `json:"typeName" yaml:"typeName"` // The caching configuration for this resolver. // Experimental. CachingConfig *CachingConfig `json:"cachingConfig" yaml:"cachingConfig"` // configuration of the pipeline resolver. // Experimental. PipelineConfig *[]IAppsyncFunction `json:"pipelineConfig" yaml:"pipelineConfig"` // The request mapping template for this resolver. // Experimental. RequestMappingTemplate MappingTemplate `json:"requestMappingTemplate" yaml:"requestMappingTemplate"` // The response mapping template for this resolver. // Experimental. ResponseMappingTemplate MappingTemplate `json:"responseMappingTemplate" yaml:"responseMappingTemplate"` // The data source this resolver is using. // Experimental. DataSource BaseDataSource `json:"dataSource" yaml:"dataSource"` // The API this resolver is attached to. // Experimental. Api IGraphqlApi `json:"api" yaml:"api"` }
Additional property for an AppSync resolver for GraphQL API reference.
TODO: EXAMPLE
Experimental.
type Schema ¶
type Schema interface { Definition() *string SetDefinition(val *string) AddMutation(fieldName *string, field ResolvableField) ObjectType AddQuery(fieldName *string, field ResolvableField) ObjectType AddSubscription(fieldName *string, field Field) ObjectType AddToSchema(addition *string, delimiter *string) AddType(type_ IIntermediateType) IIntermediateType Bind(api GraphqlApi) CfnGraphQLSchema }
The Schema for a GraphQL Api.
If no options are configured, schema will be generated code-first.
TODO: EXAMPLE
Experimental.
func Schema_FromAsset ¶
Generate a Schema from file.
Returns: `SchemaAsset` with immutable schema defintion Experimental.
type SchemaOptions ¶
type SchemaOptions struct { // The file path for the schema. // // When this option is // configured, then the schema will be generated from an // existing file from disk. // Experimental. FilePath *string `json:"filePath" yaml:"filePath"` }
The options for configuring a schema.
If no options are specified, then the schema will be generated code-first.
TODO: EXAMPLE
Experimental.
type SortKeyStep ¶
type SortKeyStep interface { Auto() PrimaryKey Is(val *string) PrimaryKey }
Utility class to allow assigning a value or an auto-generated id to a sort key.
TODO: EXAMPLE
Experimental.
type Type ¶
type Type string
Enum containing the Types that can be used to define ObjectTypes. Experimental.
const ( Type_ID Type = "ID" Type_STRING Type = "STRING" Type_INT Type = "INT" Type_FLOAT Type = "FLOAT" Type_BOOLEAN Type = "BOOLEAN" Type_AWS_DATE Type = "AWS_DATE" Type_AWS_TIME Type = "AWS_TIME" Type_AWS_DATE_TIME Type = "AWS_DATE_TIME" Type_AWS_TIMESTAMP Type = "AWS_TIMESTAMP" Type_AWS_EMAIL Type = "AWS_EMAIL" Type_AWS_JSON Type = "AWS_JSON" Type_AWS_URL Type = "AWS_URL" Type_AWS_PHONE Type = "AWS_PHONE" Type_AWS_IP_ADDRESS Type = "AWS_IP_ADDRESS" Type_INTERMEDIATE Type = "INTERMEDIATE" )
type UnionType ¶
type UnionType interface { IIntermediateType Definition() *map[string]IField Modes() *[]AuthorizationType SetModes(val *[]AuthorizationType) Name() *string AddField(options *AddFieldOptions) Attribute(options *BaseTypeOptions) GraphqlType ToString() *string }
Union Types are abstract types that are similar to Interface Types, but they cannot to specify any common fields between types.
Note that fields of a union type need to be object types. In other words, you can't create a union type out of interfaces, other unions, or inputs.
TODO: EXAMPLE
Experimental.
func NewUnionType ¶
func NewUnionType(name *string, options *UnionTypeOptions) UnionType
Experimental.
type UnionTypeOptions ¶
type UnionTypeOptions struct { // the object types for this union type. // Experimental. Definition *[]IIntermediateType `json:"definition" yaml:"definition"` }
Properties for configuring an Union Type.
TODO: EXAMPLE
Experimental.
type UserPoolConfig ¶
type UserPoolConfig struct { // The Cognito user pool to use as identity source. // Experimental. UserPool awscognito.IUserPool `json:"userPool" yaml:"userPool"` // the optional app id regex. // Experimental. AppIdClientRegex *string `json:"appIdClientRegex" yaml:"appIdClientRegex"` // Default auth action. // Experimental. DefaultAction UserPoolDefaultAction `json:"defaultAction" yaml:"defaultAction"` }
Configuration for Cognito user-pools in AppSync.
TODO: EXAMPLE
Experimental.
type UserPoolDefaultAction ¶
type UserPoolDefaultAction string
enum with all possible values for Cognito user-pool default actions. Experimental.
const ( UserPoolDefaultAction_ALLOW UserPoolDefaultAction = "ALLOW" UserPoolDefaultAction_DENY UserPoolDefaultAction = "DENY" )