Documentation
¶
Overview ¶
nolint: lll Package appsync exports types, functions, subpackages for provisioning appsync resources.
> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).
Index ¶
- type ApiKey
- type ApiKeyArgs
- type ApiKeyState
- type DataSource
- func (r *DataSource) ApiId() *pulumi.StringOutput
- func (r *DataSource) Arn() *pulumi.StringOutput
- func (r *DataSource) Description() *pulumi.StringOutput
- func (r *DataSource) DynamodbConfig() *pulumi.Output
- func (r *DataSource) ElasticsearchConfig() *pulumi.Output
- func (r *DataSource) HttpConfig() *pulumi.Output
- func (r *DataSource) ID() *pulumi.IDOutput
- func (r *DataSource) LambdaConfig() *pulumi.Output
- func (r *DataSource) Name() *pulumi.StringOutput
- func (r *DataSource) ServiceRoleArn() *pulumi.StringOutput
- func (r *DataSource) Type() *pulumi.StringOutput
- func (r *DataSource) URN() *pulumi.URNOutput
- type DataSourceArgs
- type DataSourceState
- type Function
- func (r *Function) ApiId() *pulumi.StringOutput
- func (r *Function) Arn() *pulumi.StringOutput
- func (r *Function) DataSource() *pulumi.StringOutput
- func (r *Function) Description() *pulumi.StringOutput
- func (r *Function) FunctionId() *pulumi.StringOutput
- func (r *Function) FunctionVersion() *pulumi.StringOutput
- func (r *Function) ID() *pulumi.IDOutput
- func (r *Function) Name() *pulumi.StringOutput
- func (r *Function) RequestMappingTemplate() *pulumi.StringOutput
- func (r *Function) ResponseMappingTemplate() *pulumi.StringOutput
- func (r *Function) URN() *pulumi.URNOutput
- type FunctionArgs
- type FunctionState
- type GraphQLApi
- func (r *GraphQLApi) Arn() *pulumi.StringOutput
- func (r *GraphQLApi) AuthenticationType() *pulumi.StringOutput
- func (r *GraphQLApi) ID() *pulumi.IDOutput
- func (r *GraphQLApi) LogConfig() *pulumi.Output
- func (r *GraphQLApi) Name() *pulumi.StringOutput
- func (r *GraphQLApi) OpenidConnectConfig() *pulumi.Output
- func (r *GraphQLApi) Schema() *pulumi.StringOutput
- func (r *GraphQLApi) Tags() *pulumi.MapOutput
- func (r *GraphQLApi) URN() *pulumi.URNOutput
- func (r *GraphQLApi) Uris() *pulumi.MapOutput
- func (r *GraphQLApi) UserPoolConfig() *pulumi.Output
- type GraphQLApiArgs
- type GraphQLApiState
- type Resolver
- func (r *Resolver) ApiId() *pulumi.StringOutput
- func (r *Resolver) Arn() *pulumi.StringOutput
- func (r *Resolver) DataSource() *pulumi.StringOutput
- func (r *Resolver) Field() *pulumi.StringOutput
- func (r *Resolver) ID() *pulumi.IDOutput
- func (r *Resolver) Kind() *pulumi.StringOutput
- func (r *Resolver) PipelineConfig() *pulumi.Output
- func (r *Resolver) RequestTemplate() *pulumi.StringOutput
- func (r *Resolver) ResponseTemplate() *pulumi.StringOutput
- func (r *Resolver) Type() *pulumi.StringOutput
- func (r *Resolver) URN() *pulumi.URNOutput
- type ResolverArgs
- type ResolverState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiKey ¶ added in v0.15.1
type ApiKey struct {
// contains filtered or unexported fields
}
Provides an AppSync API Key.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/appsync_api_key.html.markdown.
func GetApiKey ¶ added in v0.15.1
func GetApiKey(ctx *pulumi.Context, name string, id pulumi.ID, state *ApiKeyState, opts ...pulumi.ResourceOpt) (*ApiKey, error)
GetApiKey gets an existing ApiKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewApiKey ¶ added in v0.15.1
func NewApiKey(ctx *pulumi.Context, name string, args *ApiKeyArgs, opts ...pulumi.ResourceOpt) (*ApiKey, error)
NewApiKey registers a new resource with the given unique name, arguments, and options.
func (*ApiKey) ApiId ¶ added in v0.15.1
func (r *ApiKey) ApiId() *pulumi.StringOutput
The ID of the associated AppSync API
func (*ApiKey) Description ¶ added in v0.15.1
func (r *ApiKey) Description() *pulumi.StringOutput
func (*ApiKey) Expires ¶ added in v0.15.1
func (r *ApiKey) Expires() *pulumi.StringOutput
RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation.
type ApiKeyArgs ¶ added in v0.15.1
type ApiKeyArgs struct { // The ID of the associated AppSync API ApiId interface{} Description interface{} // RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation. Expires interface{} }
The set of arguments for constructing a ApiKey resource.
type ApiKeyState ¶ added in v0.15.1
type ApiKeyState struct { // The ID of the associated AppSync API ApiId interface{} Description interface{} // RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation. Expires interface{} // The API key Key interface{} }
Input properties used for looking up and filtering ApiKey resources.
type DataSource ¶
type DataSource struct {
// contains filtered or unexported fields
}
Provides an AppSync DataSource.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/appsync_datasource.html.markdown.
func GetDataSource ¶
func GetDataSource(ctx *pulumi.Context, name string, id pulumi.ID, state *DataSourceState, opts ...pulumi.ResourceOpt) (*DataSource, error)
GetDataSource gets an existing DataSource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewDataSource ¶
func NewDataSource(ctx *pulumi.Context, name string, args *DataSourceArgs, opts ...pulumi.ResourceOpt) (*DataSource, error)
NewDataSource registers a new resource with the given unique name, arguments, and options.
func (*DataSource) ApiId ¶
func (r *DataSource) ApiId() *pulumi.StringOutput
The API ID for the GraphQL API for the DataSource.
func (*DataSource) Description ¶
func (r *DataSource) Description() *pulumi.StringOutput
A description of the DataSource.
func (*DataSource) DynamodbConfig ¶
func (r *DataSource) DynamodbConfig() *pulumi.Output
DynamoDB settings. See below
func (*DataSource) ElasticsearchConfig ¶
func (r *DataSource) ElasticsearchConfig() *pulumi.Output
Amazon Elasticsearch settings. See below
func (*DataSource) HttpConfig ¶ added in v0.16.1
func (r *DataSource) HttpConfig() *pulumi.Output
HTTP settings. See below
func (*DataSource) ID ¶
func (r *DataSource) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*DataSource) LambdaConfig ¶
func (r *DataSource) LambdaConfig() *pulumi.Output
AWS Lambda settings. See below
func (*DataSource) Name ¶
func (r *DataSource) Name() *pulumi.StringOutput
A user-supplied name for the DataSource.
func (*DataSource) ServiceRoleArn ¶
func (r *DataSource) ServiceRoleArn() *pulumi.StringOutput
The IAM service role ARN for the data source.
func (*DataSource) Type ¶
func (r *DataSource) Type() *pulumi.StringOutput
The type of the DataSource. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`.
func (*DataSource) URN ¶
func (r *DataSource) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type DataSourceArgs ¶
type DataSourceArgs struct { // The API ID for the GraphQL API for the DataSource. ApiId interface{} // A description of the DataSource. Description interface{} // DynamoDB settings. See below DynamodbConfig interface{} // Amazon Elasticsearch settings. See below ElasticsearchConfig interface{} // HTTP settings. See below HttpConfig interface{} // AWS Lambda settings. See below LambdaConfig interface{} // A user-supplied name for the DataSource. Name interface{} // The IAM service role ARN for the data source. ServiceRoleArn interface{} // The type of the DataSource. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`. Type interface{} }
The set of arguments for constructing a DataSource resource.
type DataSourceState ¶
type DataSourceState struct { // The API ID for the GraphQL API for the DataSource. ApiId interface{} // The ARN Arn interface{} // A description of the DataSource. Description interface{} // DynamoDB settings. See below DynamodbConfig interface{} // Amazon Elasticsearch settings. See below ElasticsearchConfig interface{} // HTTP settings. See below HttpConfig interface{} // AWS Lambda settings. See below LambdaConfig interface{} // A user-supplied name for the DataSource. Name interface{} // The IAM service role ARN for the data source. ServiceRoleArn interface{} // The type of the DataSource. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`. Type interface{} }
Input properties used for looking up and filtering DataSource resources.
type Function ¶ added in v0.18.16
type Function struct {
// contains filtered or unexported fields
}
Provides an AppSync Function.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/appsync_function.html.markdown.
func GetFunction ¶ added in v0.18.16
func GetFunction(ctx *pulumi.Context, name string, id pulumi.ID, state *FunctionState, opts ...pulumi.ResourceOpt) (*Function, error)
GetFunction gets an existing Function resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewFunction ¶ added in v0.18.16
func NewFunction(ctx *pulumi.Context, name string, args *FunctionArgs, opts ...pulumi.ResourceOpt) (*Function, error)
NewFunction registers a new resource with the given unique name, arguments, and options.
func (*Function) ApiId ¶ added in v0.18.16
func (r *Function) ApiId() *pulumi.StringOutput
The ID of the associated AppSync API.
func (*Function) Arn ¶ added in v0.18.16
func (r *Function) Arn() *pulumi.StringOutput
The ARN of the Function object.
func (*Function) DataSource ¶ added in v0.18.16
func (r *Function) DataSource() *pulumi.StringOutput
The Function DataSource name.
func (*Function) Description ¶ added in v0.18.16
func (r *Function) Description() *pulumi.StringOutput
The Function description.
func (*Function) FunctionId ¶ added in v0.18.16
func (r *Function) FunctionId() *pulumi.StringOutput
A unique ID representing the Function object.
func (*Function) FunctionVersion ¶ added in v0.18.16
func (r *Function) FunctionVersion() *pulumi.StringOutput
The version of the request mapping template. Currently the supported value is `2018-05-29`.
func (*Function) ID ¶ added in v0.18.16
ID is this resource's unique identifier assigned by its provider.
func (*Function) Name ¶ added in v0.18.16
func (r *Function) Name() *pulumi.StringOutput
The Function name. The function name does not have to be unique.
func (*Function) RequestMappingTemplate ¶ added in v0.18.16
func (r *Function) RequestMappingTemplate() *pulumi.StringOutput
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
func (*Function) ResponseMappingTemplate ¶ added in v0.18.16
func (r *Function) ResponseMappingTemplate() *pulumi.StringOutput
The Function response mapping template.
type FunctionArgs ¶ added in v0.18.16
type FunctionArgs struct { // The ID of the associated AppSync API. ApiId interface{} // The Function DataSource name. DataSource interface{} // The Function description. Description interface{} // The version of the request mapping template. Currently the supported value is `2018-05-29`. FunctionVersion interface{} // The Function name. The function name does not have to be unique. Name interface{} // The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. RequestMappingTemplate interface{} // The Function response mapping template. ResponseMappingTemplate interface{} }
The set of arguments for constructing a Function resource.
type FunctionState ¶ added in v0.18.16
type FunctionState struct { // The ID of the associated AppSync API. ApiId interface{} // The ARN of the Function object. Arn interface{} // The Function DataSource name. DataSource interface{} // The Function description. Description interface{} // A unique ID representing the Function object. FunctionId interface{} // The version of the request mapping template. Currently the supported value is `2018-05-29`. FunctionVersion interface{} // The Function name. The function name does not have to be unique. Name interface{} // The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. RequestMappingTemplate interface{} // The Function response mapping template. ResponseMappingTemplate interface{} }
Input properties used for looking up and filtering Function resources.
type GraphQLApi ¶
type GraphQLApi struct {
// contains filtered or unexported fields
}
Provides an AppSync GraphQL API.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/appsync_graphql_api.html.markdown.
func GetGraphQLApi ¶
func GetGraphQLApi(ctx *pulumi.Context, name string, id pulumi.ID, state *GraphQLApiState, opts ...pulumi.ResourceOpt) (*GraphQLApi, error)
GetGraphQLApi gets an existing GraphQLApi resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewGraphQLApi ¶
func NewGraphQLApi(ctx *pulumi.Context, name string, args *GraphQLApiArgs, opts ...pulumi.ResourceOpt) (*GraphQLApi, error)
NewGraphQLApi registers a new resource with the given unique name, arguments, and options.
func (*GraphQLApi) AuthenticationType ¶
func (r *GraphQLApi) AuthenticationType() *pulumi.StringOutput
The authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`
func (*GraphQLApi) ID ¶
func (r *GraphQLApi) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*GraphQLApi) LogConfig ¶ added in v0.16.1
func (r *GraphQLApi) LogConfig() *pulumi.Output
Nested argument containing logging configuration. Defined below.
func (*GraphQLApi) Name ¶
func (r *GraphQLApi) Name() *pulumi.StringOutput
A user-supplied name for the GraphqlApi.
func (*GraphQLApi) OpenidConnectConfig ¶ added in v0.16.1
func (r *GraphQLApi) OpenidConnectConfig() *pulumi.Output
Nested argument containing OpenID Connect configuration. Defined below.
func (*GraphQLApi) Schema ¶ added in v0.18.1
func (r *GraphQLApi) Schema() *pulumi.StringOutput
func (*GraphQLApi) Tags ¶ added in v0.18.4
func (r *GraphQLApi) Tags() *pulumi.MapOutput
A mapping of tags to assign to the resource.
func (*GraphQLApi) URN ¶
func (r *GraphQLApi) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*GraphQLApi) Uris ¶ added in v0.16.1
func (r *GraphQLApi) Uris() *pulumi.MapOutput
Map of URIs associated with the API. e.g. `uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql`
func (*GraphQLApi) UserPoolConfig ¶
func (r *GraphQLApi) UserPoolConfig() *pulumi.Output
The Amazon Cognito User Pool configuration. Defined below.
type GraphQLApiArgs ¶
type GraphQLApiArgs struct { // The authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT` AuthenticationType interface{} // Nested argument containing logging configuration. Defined below. LogConfig interface{} // A user-supplied name for the GraphqlApi. Name interface{} // Nested argument containing OpenID Connect configuration. Defined below. OpenidConnectConfig interface{} Schema interface{} // A mapping of tags to assign to the resource. Tags interface{} // The Amazon Cognito User Pool configuration. Defined below. UserPoolConfig interface{} }
The set of arguments for constructing a GraphQLApi resource.
type GraphQLApiState ¶
type GraphQLApiState struct { // The ARN Arn interface{} // The authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT` AuthenticationType interface{} // Nested argument containing logging configuration. Defined below. LogConfig interface{} // A user-supplied name for the GraphqlApi. Name interface{} // Nested argument containing OpenID Connect configuration. Defined below. OpenidConnectConfig interface{} Schema interface{} // A mapping of tags to assign to the resource. Tags interface{} // Map of URIs associated with the API. e.g. `uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql` Uris interface{} // The Amazon Cognito User Pool configuration. Defined below. UserPoolConfig interface{} }
Input properties used for looking up and filtering GraphQLApi resources.
type Resolver ¶ added in v0.18.1
type Resolver struct {
// contains filtered or unexported fields
}
Provides an AppSync Resolver.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/appsync_resolver.html.markdown.
func GetResolver ¶ added in v0.18.1
func GetResolver(ctx *pulumi.Context, name string, id pulumi.ID, state *ResolverState, opts ...pulumi.ResourceOpt) (*Resolver, error)
GetResolver gets an existing Resolver resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewResolver ¶ added in v0.18.1
func NewResolver(ctx *pulumi.Context, name string, args *ResolverArgs, opts ...pulumi.ResourceOpt) (*Resolver, error)
NewResolver registers a new resource with the given unique name, arguments, and options.
func (*Resolver) ApiId ¶ added in v0.18.1
func (r *Resolver) ApiId() *pulumi.StringOutput
The API ID for the GraphQL API.
func (*Resolver) DataSource ¶ added in v0.18.1
func (r *Resolver) DataSource() *pulumi.StringOutput
The DataSource name.
func (*Resolver) Field ¶ added in v0.18.1
func (r *Resolver) Field() *pulumi.StringOutput
The field name from the schema defined in the GraphQL API.
func (*Resolver) ID ¶ added in v0.18.1
ID is this resource's unique identifier assigned by its provider.
func (*Resolver) Kind ¶ added in v0.18.16
func (r *Resolver) Kind() *pulumi.StringOutput
The resolver type. Valid values are `UNIT` and `PIPELINE`.
func (*Resolver) PipelineConfig ¶ added in v0.18.16
The PipelineConfig. A `pipeline_config` block is documented below.
func (*Resolver) RequestTemplate ¶ added in v0.18.1
func (r *Resolver) RequestTemplate() *pulumi.StringOutput
The request mapping template for UNIT resolver or 'before mapping template' for PIPELINE resolver.
func (*Resolver) ResponseTemplate ¶ added in v0.18.1
func (r *Resolver) ResponseTemplate() *pulumi.StringOutput
The response mapping template for UNIT resolver or 'after mapping template' for PIPELINE resolver.
func (*Resolver) Type ¶ added in v0.18.1
func (r *Resolver) Type() *pulumi.StringOutput
The type name from the schema defined in the GraphQL API.
type ResolverArgs ¶ added in v0.18.1
type ResolverArgs struct { // The API ID for the GraphQL API. ApiId interface{} // The DataSource name. DataSource interface{} // The field name from the schema defined in the GraphQL API. Field interface{} // The resolver type. Valid values are `UNIT` and `PIPELINE`. Kind interface{} // The PipelineConfig. A `pipeline_config` block is documented below. PipelineConfig interface{} // The request mapping template for UNIT resolver or 'before mapping template' for PIPELINE resolver. RequestTemplate interface{} // The response mapping template for UNIT resolver or 'after mapping template' for PIPELINE resolver. ResponseTemplate interface{} // The type name from the schema defined in the GraphQL API. Type interface{} }
The set of arguments for constructing a Resolver resource.
type ResolverState ¶ added in v0.18.1
type ResolverState struct { // The API ID for the GraphQL API. ApiId interface{} // The ARN Arn interface{} // The DataSource name. DataSource interface{} // The field name from the schema defined in the GraphQL API. Field interface{} // The resolver type. Valid values are `UNIT` and `PIPELINE`. Kind interface{} // The PipelineConfig. A `pipeline_config` block is documented below. PipelineConfig interface{} // The request mapping template for UNIT resolver or 'before mapping template' for PIPELINE resolver. RequestTemplate interface{} // The response mapping template for UNIT resolver or 'after mapping template' for PIPELINE resolver. ResponseTemplate interface{} // The type name from the schema defined in the GraphQL API. Type interface{} }
Input properties used for looking up and filtering Resolver resources.