Skip to content

Commit

Permalink
Run 'make docs'.
Browse files Browse the repository at this point in the history
  • Loading branch information
ewbankkit committed Feb 22, 2024
1 parent e6d6aa7 commit 7aefc5c
Show file tree
Hide file tree
Showing 103 changed files with 5,295 additions and 2,240 deletions.
180 changes: 95 additions & 85 deletions docs/data-sources/acmpca_certificate.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data-sources/apigateway_authorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Data Source schema for AWS::ApiGateway::Authorizer
- `authorizer_id` (String)
- `authorizer_result_ttl_in_seconds` (Number) The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- `authorizer_uri` (String) Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
- `identity_source` (String) The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- `identity_source` (String) The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when thi
- `identity_validation_expression` (String) A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
- `name` (String) The name of the authorizer.
- `provider_ar_ns` (Set of String) A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/apigateway_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ Read-Only:
- `credentials` (String) Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null.
- `integration_http_method` (String) Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property.
- `integration_responses` (Attributes List) Specifies the integration's responses. (see [below for nested schema](#nestedatt--integration--integration_responses))
- `passthrough_behavior` (String) Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
- `passthrough_behavior` (String) Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response
- `request_parameters` (Map of String) A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name.
- `request_templates` (Map of String) Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- `timeout_in_millis` (Number) Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- `type` (String) Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a ``connectionType`` of ``VPC_LINK`` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
- `uri` (String) Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``
For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_ap

<a id="nestedatt--integration--integration_responses"></a>
### Nested Schema for `integration.integration_responses`
Expand Down
41 changes: 26 additions & 15 deletions docs/data-sources/appsync_resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,54 @@ Data Source schema for AWS::AppSync::Resolver

### Read-Only

- `api_id` (String) The AWS AppSync GraphQL API to which you want to attach this resolver.
- `api_id` (String) The APSYlong GraphQL API to which you want to attach this resolver.
- `caching_config` (Attributes) The caching configuration for the resolver. (see [below for nested schema](#nestedatt--caching_config))
- `code` (String) The resolver code that contains the request and response functions. When code is used, the runtime is required.
- `code` (String) The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.
- `code_s3_location` (String) The Amazon S3 endpoint.
- `data_source_name` (String) The resolver data source name.
- `field_name` (String) The GraphQL field on a type that invokes the resolver.
- `kind` (String) The resolver type.
- `max_batch_size` (Number) The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
+ *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.
- `max_batch_size` (Number) The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.
- `metrics_config` (String)
- `pipeline_config` (Attributes) Functions linked with the pipeline resolver. (see [below for nested schema](#nestedatt--pipeline_config))
- `request_mapping_template` (String) Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
- `request_mapping_template_s3_location` (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.
- `resolver_arn` (String) The Amazon Resource Name (ARN) for the resolver.
- `request_mapping_template` (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.
- `request_mapping_template_s3_location` (String) The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
- `resolver_arn` (String)
- `response_mapping_template` (String) The response mapping template.
- `response_mapping_template_s3_location` (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.
- `runtime` (Attributes) Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. (see [below for nested schema](#nestedatt--runtime))
- `sync_config` (Attributes) The SyncConfig for a resolver attached to a versioned data source. (see [below for nested schema](#nestedatt--sync_config))
- `response_mapping_template_s3_location` (String) The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
- `runtime` (Attributes) Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. (see [below for nested schema](#nestedatt--runtime))
- `sync_config` (Attributes) The ``SyncConfig`` for a resolver attached to a versioned data source. (see [below for nested schema](#nestedatt--sync_config))
- `type_name` (String) The GraphQL type that invokes this resolver.

<a id="nestedatt--caching_config"></a>
### Nested Schema for `caching_config`

Read-Only:

- `caching_keys` (List of String) The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
- `ttl` (Number) The TTL in seconds for a resolver that has caching activated. Valid values are 1-36.00 seconds.
- `caching_keys` (List of String) The caching keys for a resolver that has caching activated.
Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps.
- `ttl` (Number) The TTL in seconds for a resolver that has caching activated.
Valid values are 1?3,600 seconds.


<a id="nestedatt--pipeline_config"></a>
### Nested Schema for `pipeline_config`

Read-Only:

- `functions` (List of String) A list of Function objects.
- `functions` (List of String) A list of ``Function`` objects.


<a id="nestedatt--runtime"></a>
### Nested Schema for `runtime`

Read-Only:

- `name` (String) The name of the runtime to use.
- `runtime_version` (String) The version of the runtime to use.
- `name` (String) The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``.
- `runtime_version` (String) The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``.


<a id="nestedatt--sync_config"></a>
Expand All @@ -71,8 +77,13 @@ Read-Only:
Read-Only:

- `conflict_detection` (String) 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.
- `conflict_handler` (String) The Conflict Resolution strategy to perform in the event of a conflict.
- `lambda_conflict_handler_config` (Attributes) The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. (see [below for nested schema](#nestedatt--sync_config--lambda_conflict_handler_config))
+ *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 LAMlong function supplied in the ``LambdaConflictHandlerConfig``.
- `lambda_conflict_handler_config` (Attributes) The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler. (see [below for nested schema](#nestedatt--sync_config--lambda_conflict_handler_config))

<a id="nestedatt--sync_config--lambda_conflict_handler_config"></a>
### Nested Schema for `sync_config.lambda_conflict_handler_config`
Expand Down
Loading

0 comments on commit 7aefc5c

Please sign in to comment.