Documentation ¶
Index ¶
- func CfnApiCache_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiCache_IsCfnElement(x interface{}) *bool
- func CfnApiCache_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApiCache_IsConstruct(x interface{}) *bool
- func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiKey_IsCfnElement(x interface{}) *bool
- func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApiKey_IsConstruct(x interface{}) *bool
- func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataSource_IsCfnElement(x interface{}) *bool
- func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataSource_IsConstruct(x interface{}) *bool
- func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainNameApiAssociation_IsCfnElement(x interface{}) *bool
- func CfnDomainNameApiAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomainNameApiAssociation_IsConstruct(x interface{}) *bool
- func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainName_IsCfnElement(x interface{}) *bool
- func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomainName_IsConstruct(x interface{}) *bool
- func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFunctionConfiguration_IsCfnElement(x interface{}) *bool
- func CfnFunctionConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFunctionConfiguration_IsConstruct(x interface{}) *bool
- func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGraphQLApi_IsCfnElement(x interface{}) *bool
- func CfnGraphQLApi_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGraphQLApi_IsConstruct(x interface{}) *bool
- func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGraphQLSchema_IsCfnElement(x interface{}) *bool
- func CfnGraphQLSchema_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGraphQLSchema_IsConstruct(x interface{}) *bool
- func CfnResolver_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResolver_IsCfnElement(x interface{}) *bool
- func CfnResolver_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResolver_IsConstruct(x interface{}) *bool
- func NewCfnApiCache_Override(c CfnApiCache, scope constructs.Construct, id *string, props *CfnApiCacheProps)
- func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
- func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, ...)
- func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, ...)
- func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope constructs.Construct, id *string, ...)
- func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope constructs.Construct, id *string, ...)
- func NewCfnResolver_Override(c CfnResolver, scope constructs.Construct, id *string, props *CfnResolverProps)
- type CfnApiCache
- type CfnApiCacheProps
- type CfnApiKey
- type CfnApiKeyProps
- type CfnDataSource
- type CfnDataSourceProps
- type CfnDataSource_AuthorizationConfigProperty
- type CfnDataSource_AwsIamConfigProperty
- type CfnDataSource_DeltaSyncConfigProperty
- type CfnDataSource_DynamoDBConfigProperty
- type CfnDataSource_ElasticsearchConfigProperty
- type CfnDataSource_HttpConfigProperty
- type CfnDataSource_LambdaConfigProperty
- type CfnDataSource_OpenSearchServiceConfigProperty
- type CfnDataSource_RdsHttpEndpointConfigProperty
- type CfnDataSource_RelationalDatabaseConfigProperty
- type CfnDomainName
- type CfnDomainNameApiAssociation
- type CfnDomainNameApiAssociationProps
- type CfnDomainNameProps
- type CfnFunctionConfiguration
- type CfnFunctionConfigurationProps
- type CfnFunctionConfiguration_LambdaConflictHandlerConfigProperty
- type CfnFunctionConfiguration_SyncConfigProperty
- type CfnGraphQLApi
- type CfnGraphQLApiProps
- type CfnGraphQLApi_AdditionalAuthenticationProviderProperty
- type CfnGraphQLApi_CognitoUserPoolConfigProperty
- type CfnGraphQLApi_LambdaAuthorizerConfigProperty
- type CfnGraphQLApi_LogConfigProperty
- type CfnGraphQLApi_OpenIDConnectConfigProperty
- type CfnGraphQLApi_UserPoolConfigProperty
- type CfnGraphQLSchema
- type CfnGraphQLSchemaProps
- type CfnResolver
- type CfnResolverProps
- type CfnResolver_CachingConfigProperty
- type CfnResolver_LambdaConflictHandlerConfigProperty
- type CfnResolver_PipelineConfigProperty
- type CfnResolver_SyncConfigProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApiCache_CFN_RESOURCE_TYPE_NAME ¶
func CfnApiCache_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiCache_IsCfnElement ¶
func CfnApiCache_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiCache_IsCfnResource ¶
func CfnApiCache_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApiCache_IsConstruct ¶
func CfnApiCache_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnApiKey_CFN_RESOURCE_TYPE_NAME ¶
func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiKey_IsCfnElement ¶
func CfnApiKey_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiKey_IsCfnResource ¶
func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApiKey_IsConstruct ¶
func CfnApiKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnDataSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataSource_IsCfnElement ¶
func CfnDataSource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDataSource_IsCfnResource ¶
func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDataSource_IsConstruct ¶
func CfnDataSource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnDomainNameApiAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainNameApiAssociation_IsCfnElement ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomainNameApiAssociation_IsCfnResource ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomainNameApiAssociation_IsConstruct ¶ added in v2.2.0
func CfnDomainNameApiAssociation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnDomainName_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainName_IsCfnElement ¶ added in v2.2.0
func CfnDomainName_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomainName_IsCfnResource ¶ added in v2.2.0
func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomainName_IsConstruct ¶ added in v2.2.0
func CfnDomainName_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnFunctionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnFunctionConfiguration_IsCfnElement ¶
func CfnFunctionConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFunctionConfiguration_IsCfnResource ¶
func CfnFunctionConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFunctionConfiguration_IsConstruct ¶
func CfnFunctionConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME ¶
func CfnGraphQLApi_CFN_RESOURCE_TYPE_NAME() *string
func CfnGraphQLApi_IsCfnElement ¶
func CfnGraphQLApi_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGraphQLApi_IsCfnResource ¶
func CfnGraphQLApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGraphQLApi_IsConstruct ¶
func CfnGraphQLApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME ¶
func CfnGraphQLSchema_CFN_RESOURCE_TYPE_NAME() *string
func CfnGraphQLSchema_IsCfnElement ¶
func CfnGraphQLSchema_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGraphQLSchema_IsCfnResource ¶
func CfnGraphQLSchema_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGraphQLSchema_IsConstruct ¶
func CfnGraphQLSchema_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func CfnResolver_CFN_RESOURCE_TYPE_NAME ¶
func CfnResolver_CFN_RESOURCE_TYPE_NAME() *string
func CfnResolver_IsCfnElement ¶
func CfnResolver_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnResolver_IsCfnResource ¶
func CfnResolver_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResolver_IsConstruct ¶
func CfnResolver_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.
func NewCfnApiCache_Override ¶
func NewCfnApiCache_Override(c CfnApiCache, scope constructs.Construct, id *string, props *CfnApiCacheProps)
Create a new `AWS::AppSync::ApiCache`.
func NewCfnApiKey_Override ¶
func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
Create a new `AWS::AppSync::ApiKey`.
func NewCfnDataSource_Override ¶
func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, props *CfnDataSourceProps)
Create a new `AWS::AppSync::DataSource`.
func NewCfnDomainNameApiAssociation_Override ¶ added in v2.2.0
func NewCfnDomainNameApiAssociation_Override(c CfnDomainNameApiAssociation, scope constructs.Construct, id *string, props *CfnDomainNameApiAssociationProps)
Create a new `AWS::AppSync::DomainNameApiAssociation`.
func NewCfnDomainName_Override ¶ added in v2.2.0
func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, props *CfnDomainNameProps)
Create a new `AWS::AppSync::DomainName`.
func NewCfnFunctionConfiguration_Override ¶
func NewCfnFunctionConfiguration_Override(c CfnFunctionConfiguration, scope constructs.Construct, id *string, props *CfnFunctionConfigurationProps)
Create a new `AWS::AppSync::FunctionConfiguration`.
func NewCfnGraphQLApi_Override ¶
func NewCfnGraphQLApi_Override(c CfnGraphQLApi, scope constructs.Construct, id *string, props *CfnGraphQLApiProps)
Create a new `AWS::AppSync::GraphQLApi`.
func NewCfnGraphQLSchema_Override ¶
func NewCfnGraphQLSchema_Override(c CfnGraphQLSchema, scope constructs.Construct, id *string, props *CfnGraphQLSchemaProps)
Create a new `AWS::AppSync::GraphQLSchema`.
func NewCfnResolver_Override ¶
func NewCfnResolver_Override(c CfnResolver, scope constructs.Construct, id *string, props *CfnResolverProps)
Create a new `AWS::AppSync::Resolver`.
Types ¶
type CfnApiCache ¶
type CfnApiCache interface { awscdk.CfnResource awscdk.IInspectable // Caching behavior. // // - *FULL_REQUEST_CACHING* : All requests are fully cached. // - *PER_RESOLVER_CACHING* : Individual resolvers that you specify are cached. ApiCachingBehavior() *string SetApiCachingBehavior(val *string) // The GraphQL API ID. ApiId() *string SetApiId(val *string) // At-rest encryption flag for cache. // // You cannot update this setting after creation. AtRestEncryptionEnabled() interface{} SetAtRestEncryptionEnabled(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Transit encryption flag when connecting to cache. // // You cannot update this setting after creation. TransitEncryptionEnabled() interface{} SetTransitEncryptionEnabled(val interface{}) // TTL in seconds for cache entries. // // Valid values are 1–3,600 seconds. Ttl() *float64 SetTtl(val *float64) // 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 SetType(val *string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::ApiCache`.
The `AWS::AppSync::ApiCache` resource represents the input of a `CreateApiCache` operation.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnApiCache := appsync.NewCfnApiCache(this, jsii.String("MyCfnApiCache"), &cfnApiCacheProps{ apiCachingBehavior: jsii.String("apiCachingBehavior"), apiId: jsii.String("apiId"), ttl: jsii.Number(123), type: jsii.String("type"), // the properties below are optional atRestEncryptionEnabled: jsii.Boolean(false), transitEncryptionEnabled: jsii.Boolean(false), })
func NewCfnApiCache ¶
func NewCfnApiCache(scope constructs.Construct, id *string, props *CfnApiCacheProps) CfnApiCache
Create a new `AWS::AppSync::ApiCache`.
type CfnApiCacheProps ¶
type CfnApiCacheProps struct { // Caching behavior. // // - *FULL_REQUEST_CACHING* : All requests are fully cached. // - *PER_RESOLVER_CACHING* : Individual resolvers that you specify are cached. ApiCachingBehavior *string `json:"apiCachingBehavior" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnApiCacheProps := &cfnApiCacheProps{ apiCachingBehavior: jsii.String("apiCachingBehavior"), apiId: jsii.String("apiId"), ttl: jsii.Number(123), type: jsii.String("type"), // the properties below are optional atRestEncryptionEnabled: jsii.Boolean(false), transitEncryptionEnabled: jsii.Boolean(false), }
type CfnApiKey ¶
type CfnApiKey interface { awscdk.CfnResource awscdk.IInspectable // Unique AWS AppSync GraphQL API ID for this API key. ApiId() *string SetApiId(val *string) // The API key ID. ApiKeyId() *string SetApiKeyId(val *string) // The API key. AttrApiKey() *string // The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi` . AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Unique description of your API key. Description() *string SetDescription(val *string) // 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 SetExpires(val *float64) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::ApiKey`.
The `AWS::AppSync::ApiKey` resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnApiKey := appsync.NewCfnApiKey(this, jsii.String("MyCfnApiKey"), &cfnApiKeyProps{ apiId: jsii.String("apiId"), // the properties below are optional apiKeyId: jsii.String("apiKeyId"), description: jsii.String("description"), expires: jsii.Number(123), })
func NewCfnApiKey ¶
func NewCfnApiKey(scope constructs.Construct, id *string, props *CfnApiKeyProps) CfnApiKey
Create a new `AWS::AppSync::ApiKey`.
type CfnApiKeyProps ¶
type CfnApiKeyProps struct { // Unique AWS AppSync GraphQL API ID for this API key. ApiId *string `json:"apiId" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnApiKeyProps := &cfnApiKeyProps{ apiId: jsii.String("apiId"), // the properties below are optional apiKeyId: jsii.String("apiKeyId"), description: jsii.String("description"), expires: jsii.Number(123), }
type CfnDataSource ¶
type CfnDataSource interface { awscdk.CfnResource awscdk.IInspectable // Unique AWS AppSync GraphQL API identifier where this data source will be created. ApiId() *string SetApiId(val *string) // The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename` . AttrDataSourceArn() *string // Friendly name for you to identify your AWS AppSync data source after creation. AttrName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the data source. Description() *string SetDescription(val *string) // AWS Region and TableName for an Amazon DynamoDB table in your account. DynamoDbConfig() interface{} SetDynamoDbConfig(val interface{}) // 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{} SetElasticsearchConfig(val interface{}) // Endpoints for an HTTP data source. HttpConfig() interface{} SetHttpConfig(val interface{}) // 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{} SetLambdaConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Friendly name for you to identify your AppSync data source after creation. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. OpenSearchServiceConfig() interface{} SetOpenSearchServiceConfig(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Relational Database configuration of the relational database data source. RelationalDatabaseConfig() interface{} SetRelationalDatabaseConfig(val interface{}) // 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 SetServiceRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // 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 SetType(val *string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DataSource`.
The `AWS::AppSync::DataSource` resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service . Resolvers use these data sources to fetch data when clients make GraphQL calls.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDataSource := appsync.NewCfnDataSource(this, jsii.String("MyCfnDataSource"), &cfnDataSourceProps{ apiId: jsii.String("apiId"), name: jsii.String("name"), type: jsii.String("type"), // the properties below are optional description: jsii.String("description"), dynamoDbConfig: &dynamoDBConfigProperty{ awsRegion: jsii.String("awsRegion"), tableName: jsii.String("tableName"), // the properties below are optional deltaSyncConfig: &deltaSyncConfigProperty{ baseTableTtl: jsii.String("baseTableTtl"), deltaSyncTableName: jsii.String("deltaSyncTableName"), deltaSyncTableTtl: jsii.String("deltaSyncTableTtl"), }, useCallerCredentials: jsii.Boolean(false), versioned: jsii.Boolean(false), }, elasticsearchConfig: &elasticsearchConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }, httpConfig: &httpConfigProperty{ endpoint: jsii.String("endpoint"), // the properties below are optional authorizationConfig: &authorizationConfigProperty{ authorizationType: jsii.String("authorizationType"), // the properties below are optional awsIamConfig: &awsIamConfigProperty{ signingRegion: jsii.String("signingRegion"), signingServiceName: jsii.String("signingServiceName"), }, }, }, lambdaConfig: &lambdaConfigProperty{ lambdaFunctionArn: jsii.String("lambdaFunctionArn"), }, openSearchServiceConfig: &openSearchServiceConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }, relationalDatabaseConfig: &relationalDatabaseConfigProperty{ relationalDatabaseSourceType: jsii.String("relationalDatabaseSourceType"), // the properties below are optional rdsHttpEndpointConfig: &rdsHttpEndpointConfigProperty{ awsRegion: jsii.String("awsRegion"), awsSecretStoreArn: jsii.String("awsSecretStoreArn"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), // the properties below are optional databaseName: jsii.String("databaseName"), schema: jsii.String("schema"), }, }, serviceRoleArn: jsii.String("serviceRoleArn"), })
func NewCfnDataSource ¶
func NewCfnDataSource(scope constructs.Construct, id *string, props *CfnDataSourceProps) CfnDataSource
Create a new `AWS::AppSync::DataSource`.
type CfnDataSourceProps ¶
type CfnDataSourceProps struct { // Unique AWS AppSync GraphQL API identifier where this data source will be created. ApiId *string `json:"apiId" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDataSourceProps := &cfnDataSourceProps{ apiId: jsii.String("apiId"), name: jsii.String("name"), type: jsii.String("type"), // the properties below are optional description: jsii.String("description"), dynamoDbConfig: &dynamoDBConfigProperty{ awsRegion: jsii.String("awsRegion"), tableName: jsii.String("tableName"), // the properties below are optional deltaSyncConfig: &deltaSyncConfigProperty{ baseTableTtl: jsii.String("baseTableTtl"), deltaSyncTableName: jsii.String("deltaSyncTableName"), deltaSyncTableTtl: jsii.String("deltaSyncTableTtl"), }, useCallerCredentials: jsii.Boolean(false), versioned: jsii.Boolean(false), }, elasticsearchConfig: &elasticsearchConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }, httpConfig: &httpConfigProperty{ endpoint: jsii.String("endpoint"), // the properties below are optional authorizationConfig: &authorizationConfigProperty{ authorizationType: jsii.String("authorizationType"), // the properties below are optional awsIamConfig: &awsIamConfigProperty{ signingRegion: jsii.String("signingRegion"), signingServiceName: jsii.String("signingServiceName"), }, }, }, lambdaConfig: &lambdaConfigProperty{ lambdaFunctionArn: jsii.String("lambdaFunctionArn"), }, openSearchServiceConfig: &openSearchServiceConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }, relationalDatabaseConfig: &relationalDatabaseConfigProperty{ relationalDatabaseSourceType: jsii.String("relationalDatabaseSourceType"), // the properties below are optional rdsHttpEndpointConfig: &rdsHttpEndpointConfigProperty{ awsRegion: jsii.String("awsRegion"), awsSecretStoreArn: jsii.String("awsSecretStoreArn"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), // the properties below are optional databaseName: jsii.String("databaseName"), schema: jsii.String("schema"), }, }, serviceRoleArn: jsii.String("serviceRoleArn"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" authorizationConfigProperty := &authorizationConfigProperty{ authorizationType: jsii.String("authorizationType"), // the properties below are optional awsIamConfig: &awsIamConfigProperty{ signingRegion: jsii.String("signingRegion"), signingServiceName: jsii.String("signingServiceName"), }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" awsIamConfigProperty := &awsIamConfigProperty{ signingRegion: jsii.String("signingRegion"), signingServiceName: jsii.String("signingServiceName"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" deltaSyncConfigProperty := &deltaSyncConfigProperty{ baseTableTtl: jsii.String("baseTableTtl"), deltaSyncTableName: jsii.String("deltaSyncTableName"), deltaSyncTableTtl: jsii.String("deltaSyncTableTtl"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" dynamoDBConfigProperty := &dynamoDBConfigProperty{ awsRegion: jsii.String("awsRegion"), tableName: jsii.String("tableName"), // the properties below are optional deltaSyncConfig: &deltaSyncConfigProperty{ baseTableTtl: jsii.String("baseTableTtl"), deltaSyncTableName: jsii.String("deltaSyncTableName"), deltaSyncTableTtl: jsii.String("deltaSyncTableTtl"), }, useCallerCredentials: jsii.Boolean(false), versioned: jsii.Boolean(false), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" elasticsearchConfigProperty := &elasticsearchConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" httpConfigProperty := &httpConfigProperty{ endpoint: jsii.String("endpoint"), // the properties below are optional authorizationConfig: &authorizationConfigProperty{ authorizationType: jsii.String("authorizationType"), // the properties below are optional awsIamConfig: &awsIamConfigProperty{ signingRegion: jsii.String("signingRegion"), signingServiceName: jsii.String("signingServiceName"), }, }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" lambdaConfigProperty := &lambdaConfigProperty{ lambdaFunctionArn: jsii.String("lambdaFunctionArn"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" openSearchServiceConfigProperty := &openSearchServiceConfigProperty{ awsRegion: jsii.String("awsRegion"), endpoint: jsii.String("endpoint"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" rdsHttpEndpointConfigProperty := &rdsHttpEndpointConfigProperty{ awsRegion: jsii.String("awsRegion"), awsSecretStoreArn: jsii.String("awsSecretStoreArn"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), // the properties below are optional databaseName: jsii.String("databaseName"), schema: jsii.String("schema"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" relationalDatabaseConfigProperty := &relationalDatabaseConfigProperty{ relationalDatabaseSourceType: jsii.String("relationalDatabaseSourceType"), // the properties below are optional rdsHttpEndpointConfig: &rdsHttpEndpointConfigProperty{ awsRegion: jsii.String("awsRegion"), awsSecretStoreArn: jsii.String("awsSecretStoreArn"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), // the properties below are optional databaseName: jsii.String("databaseName"), schema: jsii.String("schema"), }, }
type CfnDomainName ¶ added in v2.2.0
type CfnDomainName interface { awscdk.CfnResource awscdk.IInspectable // The domain name provided by AWS AppSync . AttrAppSyncDomainName() *string AttrDomainName() *string // The ID of your Amazon Route 53 hosted zone. AttrHostedZoneId() *string // The Amazon Resource Name (ARN) of the certificate. // // This will be an AWS Certificate Manager certificate. CertificateArn() *string SetCertificateArn(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The decription for your domain name. Description() *string SetDescription(val *string) // The domain name. DomainName() *string SetDomainName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DomainName`.
The `AWS::AppSync::DomainName` resource creates a `DomainNameConfig` object to configure a custom domain.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDomainName := appsync.NewCfnDomainName(this, jsii.String("MyCfnDomainName"), &cfnDomainNameProps{ certificateArn: jsii.String("certificateArn"), domainName: jsii.String("domainName"), // the properties below are optional description: jsii.String("description"), })
func NewCfnDomainName ¶ added in v2.2.0
func NewCfnDomainName(scope constructs.Construct, id *string, props *CfnDomainNameProps) CfnDomainName
Create a new `AWS::AppSync::DomainName`.
type CfnDomainNameApiAssociation ¶ added in v2.2.0
type CfnDomainNameApiAssociation interface { awscdk.CfnResource awscdk.IInspectable // The API ID. ApiId() *string SetApiId(val *string) AttrApiAssociationIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The domain name. DomainName() *string SetDomainName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::DomainNameApiAssociation`.
The `AWS::AppSync::DomainNameApiAssociation` resource represents the mapping of your custom domain name to the assigned API URL.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDomainNameApiAssociation := appsync.NewCfnDomainNameApiAssociation(this, jsii.String("MyCfnDomainNameApiAssociation"), &cfnDomainNameApiAssociationProps{ apiId: jsii.String("apiId"), domainName: jsii.String("domainName"), })
func NewCfnDomainNameApiAssociation ¶ added in v2.2.0
func NewCfnDomainNameApiAssociation(scope constructs.Construct, id *string, props *CfnDomainNameApiAssociationProps) CfnDomainNameApiAssociation
Create a new `AWS::AppSync::DomainNameApiAssociation`.
type CfnDomainNameApiAssociationProps ¶ added in v2.2.0
type CfnDomainNameApiAssociationProps struct { // The API ID. ApiId *string `json:"apiId" yaml:"apiId"` // The domain name. DomainName *string `json:"domainName" yaml:"domainName"` }
Properties for defining a `CfnDomainNameApiAssociation`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDomainNameApiAssociationProps := &cfnDomainNameApiAssociationProps{ apiId: jsii.String("apiId"), domainName: jsii.String("domainName"), }
type CfnDomainNameProps ¶ added in v2.2.0
type CfnDomainNameProps struct { // The Amazon Resource Name (ARN) of the certificate. // // This will be an AWS Certificate Manager certificate. CertificateArn *string `json:"certificateArn" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnDomainNameProps := &cfnDomainNameProps{ certificateArn: jsii.String("certificateArn"), domainName: jsii.String("domainName"), // the properties below are optional description: jsii.String("description"), }
type CfnFunctionConfiguration ¶
type CfnFunctionConfiguration interface { awscdk.CfnResource awscdk.IInspectable // The AWS AppSync GraphQL API that you want to attach using this function. ApiId() *string SetApiId(val *string) // The name of data source this function will attach. AttrDataSourceName() *string // ARN of the function, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId` . AttrFunctionArn() *string // The unique ID of this function. AttrFunctionId() *string // The name of the function. AttrName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of data source this function will attach. DataSourceName() *string SetDataSourceName(val *string) // The `Function` description. Description() *string SetDescription(val *string) // The version of the request mapping template. // // Currently, only the 2018-05-29 version of the template is supported. FunctionVersion() *string SetFunctionVersion(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation. MaxBatchSize() *float64 SetMaxBatchSize(val *float64) // The name of the function. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The `Function` request mapping template. // // Functions support only the 2018-05-29 version of the request mapping template. RequestMappingTemplate() *string SetRequestMappingTemplate(val *string) // 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 SetRequestMappingTemplateS3Location(val *string) // The `Function` response mapping template. ResponseMappingTemplate() *string SetResponseMappingTemplate(val *string) // 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 SetResponseMappingTemplateS3Location(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Describes a Sync configuration for a resolver. // // Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked. SyncConfig() interface{} SetSyncConfig(val interface{}) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::FunctionConfiguration`.
The `AWS::AppSync::FunctionConfiguration` resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see [Pipeline Resolvers](https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html) in the *AWS AppSync Developer Guide* .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the AWS CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnFunctionConfiguration := appsync.NewCfnFunctionConfiguration(this, jsii.String("MyCfnFunctionConfiguration"), &cfnFunctionConfigurationProps{ apiId: jsii.String("apiId"), dataSourceName: jsii.String("dataSourceName"), functionVersion: jsii.String("functionVersion"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), maxBatchSize: jsii.Number(123), requestMappingTemplate: jsii.String("requestMappingTemplate"), requestMappingTemplateS3Location: jsii.String("requestMappingTemplateS3Location"), responseMappingTemplate: jsii.String("responseMappingTemplate"), responseMappingTemplateS3Location: jsii.String("responseMappingTemplateS3Location"), syncConfig: &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }, })
func NewCfnFunctionConfiguration ¶
func NewCfnFunctionConfiguration(scope constructs.Construct, id *string, props *CfnFunctionConfigurationProps) CfnFunctionConfiguration
Create a new `AWS::AppSync::FunctionConfiguration`.
type CfnFunctionConfigurationProps ¶
type CfnFunctionConfigurationProps struct { // The AWS AppSync GraphQL API that you want to attach using this function. ApiId *string `json:"apiId" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnFunctionConfigurationProps := &cfnFunctionConfigurationProps{ apiId: jsii.String("apiId"), dataSourceName: jsii.String("dataSourceName"), functionVersion: jsii.String("functionVersion"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), maxBatchSize: jsii.Number(123), requestMappingTemplate: jsii.String("requestMappingTemplate"), requestMappingTemplateS3Location: jsii.String("requestMappingTemplateS3Location"), responseMappingTemplate: jsii.String("responseMappingTemplate"), responseMappingTemplateS3Location: jsii.String("responseMappingTemplateS3Location"), syncConfig: &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" lambdaConflictHandlerConfigProperty := &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" syncConfigProperty := &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }
type CfnGraphQLApi ¶
type CfnGraphQLApi interface { awscdk.CfnResource awscdk.IInspectable // A list of additional authentication providers for the `GraphqlApi` API. AdditionalAuthenticationProviders() interface{} SetAdditionalAuthenticationProviders(val interface{}) // Unique AWS AppSync GraphQL API identifier. AttrApiId() *string // The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` . AttrArn() *string // The Endpoint URL of your GraphQL API. AttrGraphQlUrl() *string // 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 SetAuthenticationType(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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{} SetLambdaAuthorizerConfig(val interface{}) // The Amazon CloudWatch Logs configuration. LogConfig() interface{} SetLogConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The API name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The OpenID Connect configuration. OpenIdConnectConfig() interface{} SetOpenIdConnectConfig(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An arbitrary set of tags (key-value pairs) for this GraphQL API. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. UserPoolConfig() interface{} SetUserPoolConfig(val interface{}) // A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` . XrayEnabled() interface{} SetXrayEnabled(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::GraphQLApi`.
The `AWS::AppSync::GraphQLApi` resource creates a new AWS AppSync GraphQL API. This is the top-level construct for your application. For more information, see [Quick Start](https://docs.aws.amazon.com/appsync/latest/devguide/quickstart.html) in the *AWS AppSync Developer Guide* .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnGraphQLApi := appsync.NewCfnGraphQLApi(this, jsii.String("MyCfnGraphQLApi"), &cfnGraphQLApiProps{ authenticationType: jsii.String("authenticationType"), name: jsii.String("name"), // the properties below are optional additionalAuthenticationProviders: []interface{}{ &additionalAuthenticationProviderProperty{ authenticationType: jsii.String("authenticationType"), // the properties below are optional lambdaAuthorizerConfig: &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }, openIdConnectConfig: &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }, userPoolConfig: &cognitoUserPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), userPoolId: jsii.String("userPoolId"), }, }, }, lambdaAuthorizerConfig: &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }, logConfig: &logConfigProperty{ cloudWatchLogsRoleArn: jsii.String("cloudWatchLogsRoleArn"), excludeVerboseContent: jsii.Boolean(false), fieldLogLevel: jsii.String("fieldLogLevel"), }, openIdConnectConfig: &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }, tags: []interface{}{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, userPoolConfig: &userPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), defaultAction: jsii.String("defaultAction"), userPoolId: jsii.String("userPoolId"), }, xrayEnabled: jsii.Boolean(false), })
func NewCfnGraphQLApi ¶
func NewCfnGraphQLApi(scope constructs.Construct, id *string, props *CfnGraphQLApiProps) CfnGraphQLApi
Create a new `AWS::AppSync::GraphQLApi`.
type CfnGraphQLApiProps ¶
type CfnGraphQLApiProps struct { // Security configuration for your GraphQL API. // // For allowed values (such as `API_KEY` , `AWS_IAM` , `AMAZON_COGNITO_USER_POOLS` , `OPENID_CONNECT` , or `AWS_LAMBDA` ), see [Security](https://docs.aws.amazon.com/appsync/latest/devguide/security.html) in the *AWS AppSync Developer Guide* . AuthenticationType *string `json:"authenticationType" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnGraphQLApiProps := &cfnGraphQLApiProps{ authenticationType: jsii.String("authenticationType"), name: jsii.String("name"), // the properties below are optional additionalAuthenticationProviders: []interface{}{ &additionalAuthenticationProviderProperty{ authenticationType: jsii.String("authenticationType"), // the properties below are optional lambdaAuthorizerConfig: &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }, openIdConnectConfig: &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }, userPoolConfig: &cognitoUserPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), userPoolId: jsii.String("userPoolId"), }, }, }, lambdaAuthorizerConfig: &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }, logConfig: &logConfigProperty{ cloudWatchLogsRoleArn: jsii.String("cloudWatchLogsRoleArn"), excludeVerboseContent: jsii.Boolean(false), fieldLogLevel: jsii.String("fieldLogLevel"), }, openIdConnectConfig: &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }, tags: []interface{}{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, userPoolConfig: &userPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), defaultAction: jsii.String("defaultAction"), userPoolId: jsii.String("userPoolId"), }, xrayEnabled: jsii.Boolean(false), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" additionalAuthenticationProviderProperty := &additionalAuthenticationProviderProperty{ authenticationType: jsii.String("authenticationType"), // the properties below are optional lambdaAuthorizerConfig: &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }, openIdConnectConfig: &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }, userPoolConfig: &cognitoUserPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), userPoolId: jsii.String("userPoolId"), }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cognitoUserPoolConfigProperty := &cognitoUserPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), userPoolId: jsii.String("userPoolId"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" lambdaAuthorizerConfigProperty := &lambdaAuthorizerConfigProperty{ authorizerResultTtlInSeconds: jsii.Number(123), authorizerUri: jsii.String("authorizerUri"), identityValidationExpression: jsii.String("identityValidationExpression"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" logConfigProperty := &logConfigProperty{ cloudWatchLogsRoleArn: jsii.String("cloudWatchLogsRoleArn"), excludeVerboseContent: jsii.Boolean(false), fieldLogLevel: jsii.String("fieldLogLevel"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" openIDConnectConfigProperty := &openIDConnectConfigProperty{ authTtl: jsii.Number(123), clientId: jsii.String("clientId"), iatTtl: jsii.Number(123), issuer: jsii.String("issuer"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" userPoolConfigProperty := &userPoolConfigProperty{ appIdClientRegex: jsii.String("appIdClientRegex"), awsRegion: jsii.String("awsRegion"), defaultAction: jsii.String("defaultAction"), userPoolId: jsii.String("userPoolId"), }
type CfnGraphQLSchema ¶
type CfnGraphQLSchema interface { awscdk.CfnResource awscdk.IInspectable // The AWS AppSync GraphQL API identifier to which you want to apply this schema. ApiId() *string SetApiId(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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 SetDefinition(val *string) // 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 SetDefinitionS3Location(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::GraphQLSchema`.
The `AWS::AppSync::GraphQLSchema` resource is used for your AWS AppSync GraphQL schema that controls the data model for your API. Schema files are text written in Schema Definition Language (SDL) format. For more information about schema authoring, see [Designing a GraphQL API](https://docs.aws.amazon.com/appsync/latest/devguide/designing-a-graphql-api.html) in the *AWS AppSync Developer Guide* .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnGraphQLSchema := appsync.NewCfnGraphQLSchema(this, jsii.String("MyCfnGraphQLSchema"), &cfnGraphQLSchemaProps{ apiId: jsii.String("apiId"), // the properties below are optional definition: jsii.String("definition"), definitionS3Location: jsii.String("definitionS3Location"), })
func NewCfnGraphQLSchema ¶
func NewCfnGraphQLSchema(scope constructs.Construct, id *string, props *CfnGraphQLSchemaProps) CfnGraphQLSchema
Create a new `AWS::AppSync::GraphQLSchema`.
type CfnGraphQLSchemaProps ¶
type CfnGraphQLSchemaProps struct { // The AWS AppSync GraphQL API identifier to which you want to apply this schema. ApiId *string `json:"apiId" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnGraphQLSchemaProps := &cfnGraphQLSchemaProps{ apiId: jsii.String("apiId"), // the properties below are optional definition: jsii.String("definition"), definitionS3Location: jsii.String("definitionS3Location"), }
type CfnResolver ¶
type CfnResolver interface { awscdk.CfnResource awscdk.IInspectable // The AWS AppSync GraphQL API to which you want to attach this resolver. ApiId() *string SetApiId(val *string) // The GraphQL field on a type that invokes the resolver. AttrFieldName() *string // ARN of the resolver, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername` . AttrResolverArn() *string // The GraphQL type that invokes this resolver. AttrTypeName() *string // The caching configuration for the resolver. CachingConfig() interface{} SetCachingConfig(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The resolver data source name. DataSourceName() *string SetDataSourceName(val *string) // The GraphQL field on a type that invokes the resolver. FieldName() *string SetFieldName(val *string) // 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 SetKind(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation. MaxBatchSize() *float64 SetMaxBatchSize(val *float64) // The tree node. Node() constructs.Node // Functions linked with the pipeline resolver. PipelineConfig() interface{} SetPipelineConfig(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // 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 SetRequestMappingTemplate(val *string) // 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 SetRequestMappingTemplateS3Location(val *string) // The response mapping template. ResponseMappingTemplate() *string SetResponseMappingTemplate(val *string) // 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 SetResponseMappingTemplateS3Location(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The `SyncConfig` for a resolver attached to a versioned data source. SyncConfig() interface{} SetSyncConfig(val interface{}) // The GraphQL type that invokes this resolver. TypeName() *string SetTypeName(val *string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::AppSync::Resolver`.
The `AWS::AppSync::Resolver` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html) .
> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. > > See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnResolver := appsync.NewCfnResolver(this, jsii.String("MyCfnResolver"), &cfnResolverProps{ apiId: jsii.String("apiId"), fieldName: jsii.String("fieldName"), typeName: jsii.String("typeName"), // the properties below are optional cachingConfig: &cachingConfigProperty{ ttl: jsii.Number(123), // the properties below are optional cachingKeys: []*string{ jsii.String("cachingKeys"), }, }, dataSourceName: jsii.String("dataSourceName"), kind: jsii.String("kind"), maxBatchSize: jsii.Number(123), pipelineConfig: &pipelineConfigProperty{ functions: []*string{ jsii.String("functions"), }, }, requestMappingTemplate: jsii.String("requestMappingTemplate"), requestMappingTemplateS3Location: jsii.String("requestMappingTemplateS3Location"), responseMappingTemplate: jsii.String("responseMappingTemplate"), responseMappingTemplateS3Location: jsii.String("responseMappingTemplateS3Location"), syncConfig: &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }, })
func NewCfnResolver ¶
func NewCfnResolver(scope constructs.Construct, id *string, props *CfnResolverProps) CfnResolver
Create a new `AWS::AppSync::Resolver`.
type CfnResolverProps ¶
type CfnResolverProps struct { // The AWS AppSync GraphQL API to which you want to attach this resolver. ApiId *string `json:"apiId" 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`.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cfnResolverProps := &cfnResolverProps{ apiId: jsii.String("apiId"), fieldName: jsii.String("fieldName"), typeName: jsii.String("typeName"), // the properties below are optional cachingConfig: &cachingConfigProperty{ ttl: jsii.Number(123), // the properties below are optional cachingKeys: []*string{ jsii.String("cachingKeys"), }, }, dataSourceName: jsii.String("dataSourceName"), kind: jsii.String("kind"), maxBatchSize: jsii.Number(123), pipelineConfig: &pipelineConfigProperty{ functions: []*string{ jsii.String("functions"), }, }, requestMappingTemplate: jsii.String("requestMappingTemplate"), requestMappingTemplateS3Location: jsii.String("requestMappingTemplateS3Location"), responseMappingTemplate: jsii.String("responseMappingTemplate"), responseMappingTemplateS3Location: jsii.String("responseMappingTemplateS3Location"), syncConfig: &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" cachingConfigProperty := &cachingConfigProperty{ ttl: jsii.Number(123), // the properties below are optional cachingKeys: []*string{ jsii.String("cachingKeys"), }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" lambdaConflictHandlerConfigProperty := &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" pipelineConfigProperty := &pipelineConfigProperty{ functions: []*string{ jsii.String("functions"), }, }
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.
Example:
import awscdk "github.com/aws/aws-cdk-go/awscdk"import appsync "github.com/aws/aws-cdk-go/awscdk/aws_appsync" syncConfigProperty := &syncConfigProperty{ conflictDetection: jsii.String("conflictDetection"), // the properties below are optional conflictHandler: jsii.String("conflictHandler"), lambdaConflictHandlerConfig: &lambdaConflictHandlerConfigProperty{ lambdaConflictHandlerArn: jsii.String("lambdaConflictHandlerArn"), }, }