Module appsync

appsync

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.appsync.ApiKey(resource_name, opts=None, api_id=None, description=None, expires=None, __props__=None, __name__=None, __opts__=None)

Provides an AppSync API Key.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_id (pulumi.Input[str]) – The ID of the associated AppSync API
  • description (pulumi.Input[str]) – The API key description. Defaults to “Managed by Pulumi”.
  • expires (pulumi.Input[str]) – RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation.
api_id = None

The ID of the associated AppSync API

description = None

The API key description. Defaults to “Managed by Pulumi”.

expires = None

RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation.

key = None

The API key

static get(resource_name, id, opts=None, api_id=None, description=None, expires=None, key=None)

Get an existing ApiKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] api_id: The ID of the associated AppSync API :param pulumi.Input[str] description: The API key description. Defaults to “Managed by Pulumi”. :param pulumi.Input[str] expires: RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation. :param pulumi.Input[str] key: The API key

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.appsync.DataSource(resource_name, opts=None, api_id=None, description=None, dynamodb_config=None, elasticsearch_config=None, http_config=None, lambda_config=None, name=None, service_role_arn=None, type=None, __props__=None, __name__=None, __opts__=None)

Provides an AppSync DataSource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_id (pulumi.Input[str]) – The API ID for the GraphQL API for the DataSource.
  • description (pulumi.Input[str]) – A description of the DataSource.
  • dynamodb_config (pulumi.Input[dict]) – DynamoDB settings. See below
  • elasticsearch_config (pulumi.Input[dict]) – Amazon Elasticsearch settings. See below
  • http_config (pulumi.Input[dict]) – HTTP settings. See below
  • lambda_config (pulumi.Input[dict]) – AWS Lambda settings. See below
  • name (pulumi.Input[str]) – A user-supplied name for the DataSource.
  • service_role_arn (pulumi.Input[str]) – The IAM service role ARN for the data source.
  • type (pulumi.Input[str]) – The type of the DataSource. Valid values: AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH, HTTP, NONE.
api_id = None

The API ID for the GraphQL API for the DataSource.

arn = None

The ARN

description = None

A description of the DataSource.

dynamodb_config = None

DynamoDB settings. See below

elasticsearch_config = None

Amazon Elasticsearch settings. See below

http_config = None

HTTP settings. See below

lambda_config = None

AWS Lambda settings. See below

name = None

A user-supplied name for the DataSource.

service_role_arn = None

The IAM service role ARN for the data source.

type = None

The type of the DataSource. Valid values: AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH, HTTP, NONE.

static get(resource_name, id, opts=None, api_id=None, arn=None, description=None, dynamodb_config=None, elasticsearch_config=None, http_config=None, lambda_config=None, name=None, service_role_arn=None, type=None)

Get an existing DataSource resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] api_id: The API ID for the GraphQL API for the DataSource. :param pulumi.Input[str] arn: The ARN :param pulumi.Input[str] description: A description of the DataSource. :param pulumi.Input[dict] dynamodb_config: DynamoDB settings. See below :param pulumi.Input[dict] elasticsearch_config: Amazon Elasticsearch settings. See below :param pulumi.Input[dict] http_config: HTTP settings. See below :param pulumi.Input[dict] lambda_config: AWS Lambda settings. See below :param pulumi.Input[str] name: A user-supplied name for the DataSource. :param pulumi.Input[str] service_role_arn: The IAM service role ARN for the data source. :param pulumi.Input[str] type: The type of the DataSource. Valid values: AWS_LAMBDA, AMAZON_DYNAMODB, AMAZON_ELASTICSEARCH, HTTP, NONE.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.appsync.Function(resource_name, opts=None, api_id=None, data_source=None, description=None, function_version=None, name=None, request_mapping_template=None, response_mapping_template=None, __props__=None, __name__=None, __opts__=None)

Provides an AppSync Function.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_id (pulumi.Input[str]) – The ID of the associated AppSync API.
  • data_source (pulumi.Input[str]) – The Function DataSource name.
  • description (pulumi.Input[str]) – The Function description.
  • function_version (pulumi.Input[str]) – The version of the request mapping template. Currently the supported value is 2018-05-29.
  • name (pulumi.Input[str]) – The Function name. The function name does not have to be unique.
  • request_mapping_template (pulumi.Input[str]) – The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
  • response_mapping_template (pulumi.Input[str]) – The Function response mapping template.
api_id = None

The ID of the associated AppSync API.

arn = None

The ARN of the Function object.

data_source = None

The Function DataSource name.

description = None

The Function description.

function_id = None

A unique ID representing the Function object.

function_version = None

The version of the request mapping template. Currently the supported value is 2018-05-29.

name = None

The Function name. The function name does not have to be unique.

request_mapping_template = None

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

response_mapping_template = None

The Function response mapping template.

static get(resource_name, id, opts=None, api_id=None, arn=None, data_source=None, description=None, function_id=None, function_version=None, name=None, request_mapping_template=None, response_mapping_template=None)

Get an existing Function resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] api_id: The ID of the associated AppSync API. :param pulumi.Input[str] arn: The ARN of the Function object. :param pulumi.Input[str] data_source: The Function DataSource name. :param pulumi.Input[str] description: The Function description. :param pulumi.Input[str] function_id: A unique ID representing the Function object. :param pulumi.Input[str] function_version: The version of the request mapping template. Currently the supported value is 2018-05-29. :param pulumi.Input[str] name: The Function name. The function name does not have to be unique. :param pulumi.Input[str] request_mapping_template: The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. :param pulumi.Input[str] response_mapping_template: The Function response mapping template.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.appsync.GraphQLApi(resource_name, opts=None, authentication_type=None, log_config=None, name=None, openid_connect_config=None, schema=None, tags=None, user_pool_config=None, __props__=None, __name__=None, __opts__=None)

Provides an AppSync GraphQL API.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • authentication_type (pulumi.Input[str]) – The authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
  • log_config (pulumi.Input[dict]) – Nested argument containing logging configuration. Defined below.
  • name (pulumi.Input[str]) – A user-supplied name for the GraphqlApi.
  • openid_connect_config (pulumi.Input[dict]) – Nested argument containing OpenID Connect configuration. Defined below.
  • schema (pulumi.Input[str]) – The schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • user_pool_config (pulumi.Input[dict]) – The Amazon Cognito User Pool configuration. Defined below.
arn = None

The ARN

authentication_type = None

The authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT

log_config = None

Nested argument containing logging configuration. Defined below.

name = None

A user-supplied name for the GraphqlApi.

openid_connect_config = None

Nested argument containing OpenID Connect configuration. Defined below.

schema = None

The schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.

tags = None

A mapping of tags to assign to the resource.

uris = None

Map of URIs associated with the API. e.g. uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql

user_pool_config = None

The Amazon Cognito User Pool configuration. Defined below.

static get(resource_name, id, opts=None, arn=None, authentication_type=None, log_config=None, name=None, openid_connect_config=None, schema=None, tags=None, uris=None, user_pool_config=None)

Get an existing GraphQLApi resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] arn: The ARN :param pulumi.Input[str] authentication_type: The authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT :param pulumi.Input[dict] log_config: Nested argument containing logging configuration. Defined below. :param pulumi.Input[str] name: A user-supplied name for the GraphqlApi. :param pulumi.Input[dict] openid_connect_config: Nested argument containing OpenID Connect configuration. Defined below. :param pulumi.Input[str] schema: The schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource. :param pulumi.Input[dict] uris: Map of URIs associated with the API. e.g. uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql :param pulumi.Input[dict] user_pool_config: The Amazon Cognito User Pool configuration. Defined below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.appsync.Resolver(resource_name, opts=None, api_id=None, data_source=None, field=None, kind=None, pipeline_config=None, request_template=None, response_template=None, type=None, __props__=None, __name__=None, __opts__=None)

Provides an AppSync Resolver.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • api_id (pulumi.Input[str]) – The API ID for the GraphQL API.
  • data_source (pulumi.Input[str]) – The DataSource name.
  • field (pulumi.Input[str]) – The field name from the schema defined in the GraphQL API.
  • kind (pulumi.Input[str]) – The resolver type. Valid values are UNIT and PIPELINE.
  • pipeline_config (pulumi.Input[dict]) – The PipelineConfig. A pipeline_config block is documented below.
  • request_template (pulumi.Input[str]) – The request mapping template for UNIT resolver or ‘before mapping template’ for PIPELINE resolver.
  • response_template (pulumi.Input[str]) – The response mapping template for UNIT resolver or ‘after mapping template’ for PIPELINE resolver.
  • type (pulumi.Input[str]) – The type name from the schema defined in the GraphQL API.
api_id = None

The API ID for the GraphQL API.

arn = None

The ARN

data_source = None

The DataSource name.

field = None

The field name from the schema defined in the GraphQL API.

kind = None

The resolver type. Valid values are UNIT and PIPELINE.

pipeline_config = None

The PipelineConfig. A pipeline_config block is documented below.

request_template = None

The request mapping template for UNIT resolver or ‘before mapping template’ for PIPELINE resolver.

response_template = None

The response mapping template for UNIT resolver or ‘after mapping template’ for PIPELINE resolver.

type = None

The type name from the schema defined in the GraphQL API.

static get(resource_name, id, opts=None, api_id=None, arn=None, data_source=None, field=None, kind=None, pipeline_config=None, request_template=None, response_template=None, type=None)

Get an existing Resolver resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] api_id: The API ID for the GraphQL API. :param pulumi.Input[str] arn: The ARN :param pulumi.Input[str] data_source: The DataSource name. :param pulumi.Input[str] field: The field name from the schema defined in the GraphQL API. :param pulumi.Input[str] kind: The resolver type. Valid values are UNIT and PIPELINE. :param pulumi.Input[dict] pipeline_config: The PipelineConfig. A pipeline_config block is documented below. :param pulumi.Input[str] request_template: The request mapping template for UNIT resolver or ‘before mapping template’ for PIPELINE resolver. :param pulumi.Input[str] response_template: The response mapping template for UNIT resolver or ‘after mapping template’ for PIPELINE resolver. :param pulumi.Input[str] type: The type name from the schema defined in the GraphQL API.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str