@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
150 lines (149 loc) • 5.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an AppSync API Cache.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.appsync.GraphQLApi("example", {
* authenticationType: "API_KEY",
* name: "example",
* });
* const exampleApiCache = new aws.appsync.ApiCache("example", {
* apiId: example.id,
* apiCachingBehavior: "FULL_REQUEST_CACHING",
* type: "LARGE",
* ttl: 900,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_appsync_api_cache` using the AppSync API ID. For example:
*
* ```sh
* $ pulumi import aws:appsync/apiCache:ApiCache example xxxxx
* ```
*/
export declare class ApiCache extends pulumi.CustomResource {
/**
* Get an existing ApiCache resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiCacheState, opts?: pulumi.CustomResourceOptions): ApiCache;
/**
* Returns true if the given object is an instance of ApiCache. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiCache;
/**
* Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`.
*/
readonly apiCachingBehavior: pulumi.Output<string>;
/**
* GraphQL API ID.
*/
readonly apiId: pulumi.Output<string>;
/**
* At-rest encryption flag for cache. You cannot update this setting after creation.
*/
readonly atRestEncryptionEnabled: pulumi.Output<boolean>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Transit encryption flag when connecting to cache. You cannot update this setting after creation.
*/
readonly transitEncryptionEnabled: pulumi.Output<boolean>;
/**
* TTL in seconds for cache entries.
*/
readonly ttl: pulumi.Output<number>;
/**
* Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a ApiCache resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ApiCacheArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiCache resources.
*/
export interface ApiCacheState {
/**
* Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`.
*/
apiCachingBehavior?: pulumi.Input<string>;
/**
* GraphQL API ID.
*/
apiId?: pulumi.Input<string>;
/**
* At-rest encryption flag for cache. You cannot update this setting after creation.
*/
atRestEncryptionEnabled?: pulumi.Input<boolean>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Transit encryption flag when connecting to cache. You cannot update this setting after creation.
*/
transitEncryptionEnabled?: pulumi.Input<boolean>;
/**
* TTL in seconds for cache entries.
*/
ttl?: pulumi.Input<number>;
/**
* Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiCache resource.
*/
export interface ApiCacheArgs {
/**
* Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`.
*/
apiCachingBehavior: pulumi.Input<string>;
/**
* GraphQL API ID.
*/
apiId: pulumi.Input<string>;
/**
* At-rest encryption flag for cache. You cannot update this setting after creation.
*/
atRestEncryptionEnabled?: pulumi.Input<boolean>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Transit encryption flag when connecting to cache. You cannot update this setting after creation.
*/
transitEncryptionEnabled?: pulumi.Input<boolean>;
/**
* TTL in seconds for cache entries.
*/
ttl: pulumi.Input<number>;
/**
* Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`.
*/
type: pulumi.Input<string>;
}