Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. elasticache
  5. ServerlessCache

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticache.ServerlessCache

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.

    Create ServerlessCache Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServerlessCache(name: string, args: ServerlessCacheArgs, opts?: CustomResourceOptions);
    @overload
def ServerlessCache(resource_name: str,
                    args: ServerlessCacheArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ServerlessCache(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    engine: Optional[str] = None,
                    reader_endpoint: Optional[ServerlessCacheEndpointArgs] = None,
                    security_group_ids: Optional[Sequence[str]] = None,
                    endpoint: Optional[ServerlessCacheEndpointArgs] = None,
                    daily_snapshot_time: Optional[str] = None,
                    final_snapshot_name: Optional[str] = None,
                    kms_key_id: Optional[str] = None,
                    description: Optional[str] = None,
                    cache_usage_limits: Optional[ServerlessCacheCacheUsageLimitsArgs] = None,
                    major_engine_version: Optional[str] = None,
                    serverless_cache_name: Optional[str] = None,
                    snapshot_arns_to_restore: Optional[Sequence[str]] = None,
                    snapshot_retention_limit: Optional[int] = None,
                    subnet_ids: Optional[Sequence[str]] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                    user_group_id: Optional[str] = None)
    func NewServerlessCache(ctx *Context, name string, args ServerlessCacheArgs, opts ...ResourceOption) (*ServerlessCache, error)
    public ServerlessCache(string name, ServerlessCacheArgs args, CustomResourceOptions? opts = null)
    public ServerlessCache(String name, ServerlessCacheArgs args)
public ServerlessCache(String name, ServerlessCacheArgs args, CustomResourceOptions options)

    type: aws-native:elasticache:ServerlessCache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServerlessCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServerlessCacheArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServerlessCacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessCacheArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const serverlessCacheResource = new aws_native.elasticache.ServerlessCache("serverlessCacheResource", {
    engine: "string",
    readerEndpoint: {
        address: "string",
        port: "string",
    },
    securityGroupIds: ["string"],
    endpoint: {
        address: "string",
        port: "string",
    },
    dailySnapshotTime: "string",
    finalSnapshotName: "string",
    kmsKeyId: "string",
    description: "string",
    cacheUsageLimits: {
        dataStorage: {
            unit: aws_native.elasticache.ServerlessCacheDataStorageUnit.Gb,
            maximum: 0,
            minimum: 0,
        },
        ecpuPerSecond: {
            maximum: 0,
            minimum: 0,
        },
    },
    majorEngineVersion: "string",
    serverlessCacheName: "string",
    snapshotArnsToRestore: ["string"],
    snapshotRetentionLimit: 0,
    subnetIds: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    userGroupId: "string",
});

    Coming soon!

    ServerlessCache Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ServerlessCache resource accepts the following input properties:

    Engine string
    The engine name of the Serverless Cache.
    CacheUsageLimits Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheCacheUsageLimits
    DailySnapshotTime string
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    Description string
    The description of the Serverless Cache.
    Endpoint Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheEndpoint
    FinalSnapshotName string
    The final snapshot name which is taken before Serverless Cache is deleted.
    KmsKeyId string
    The ID of the KMS key used to encrypt the cluster.
    MajorEngineVersion string
    The major engine version of the Serverless Cache.
    ReaderEndpoint Pulumi.AwsNative.ElastiCache.Inputs.ServerlessCacheEndpoint
    SecurityGroupIds List<string>
    One or more Amazon VPC security groups associated with this Serverless Cache.
    ServerlessCacheName string
    The name of the Serverless Cache. This value must be unique.
    SnapshotArnsToRestore List<string>
    The ARN's of snapshot to restore Serverless Cache.
    SnapshotRetentionLimit int
    The snapshot retention limit of the Serverless Cache.
    SubnetIds List<string>
    The subnet id's of the Serverless Cache.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this Serverless Cache.
    UserGroupId string
    The ID of the user group.
    Engine string
    The engine name of the Serverless Cache.
    CacheUsageLimits ServerlessCacheCacheUsageLimitsArgs
    DailySnapshotTime string
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    Description string
    The description of the Serverless Cache.
    Endpoint ServerlessCacheEndpointArgs
    FinalSnapshotName string
    The final snapshot name which is taken before Serverless Cache is deleted.
    KmsKeyId string
    The ID of the KMS key used to encrypt the cluster.
    MajorEngineVersion string
    The major engine version of the Serverless Cache.
    ReaderEndpoint ServerlessCacheEndpointArgs
    SecurityGroupIds []string
    One or more Amazon VPC security groups associated with this Serverless Cache.
    ServerlessCacheName string
    The name of the Serverless Cache. This value must be unique.
    SnapshotArnsToRestore []string
    The ARN's of snapshot to restore Serverless Cache.
    SnapshotRetentionLimit int
    The snapshot retention limit of the Serverless Cache.
    SubnetIds []string
    The subnet id's of the Serverless Cache.
    Tags TagArgs
    An array of key-value pairs to apply to this Serverless Cache.
    UserGroupId string
    The ID of the user group.
    engine String
    The engine name of the Serverless Cache.
    cacheUsageLimits ServerlessCacheCacheUsageLimits
    dailySnapshotTime String
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    description String
    The description of the Serverless Cache.
    endpoint ServerlessCacheEndpoint
    finalSnapshotName String
    The final snapshot name which is taken before Serverless Cache is deleted.
    kmsKeyId String
    The ID of the KMS key used to encrypt the cluster.
    majorEngineVersion String
    The major engine version of the Serverless Cache.
    readerEndpoint ServerlessCacheEndpoint
    securityGroupIds List<String>
    One or more Amazon VPC security groups associated with this Serverless Cache.
    serverlessCacheName String
    The name of the Serverless Cache. This value must be unique.
    snapshotArnsToRestore List<String>
    The ARN's of snapshot to restore Serverless Cache.
    snapshotRetentionLimit Integer
    The snapshot retention limit of the Serverless Cache.
    subnetIds List<String>
    The subnet id's of the Serverless Cache.
    tags List<Tag>
    An array of key-value pairs to apply to this Serverless Cache.
    userGroupId String
    The ID of the user group.
    engine string
    The engine name of the Serverless Cache.
    cacheUsageLimits ServerlessCacheCacheUsageLimits
    dailySnapshotTime string
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    description string
    The description of the Serverless Cache.
    endpoint ServerlessCacheEndpoint
    finalSnapshotName string
    The final snapshot name which is taken before Serverless Cache is deleted.
    kmsKeyId string
    The ID of the KMS key used to encrypt the cluster.
    majorEngineVersion string
    The major engine version of the Serverless Cache.
    readerEndpoint ServerlessCacheEndpoint
    securityGroupIds string[]
    One or more Amazon VPC security groups associated with this Serverless Cache.
    serverlessCacheName string
    The name of the Serverless Cache. This value must be unique.
    snapshotArnsToRestore string[]
    The ARN's of snapshot to restore Serverless Cache.
    snapshotRetentionLimit number
    The snapshot retention limit of the Serverless Cache.
    subnetIds string[]
    The subnet id's of the Serverless Cache.
    tags Tag[]
    An array of key-value pairs to apply to this Serverless Cache.
    userGroupId string
    The ID of the user group.
    engine str
    The engine name of the Serverless Cache.
    cache_usage_limits ServerlessCacheCacheUsageLimitsArgs
    daily_snapshot_time str
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    description str
    The description of the Serverless Cache.
    endpoint ServerlessCacheEndpointArgs
    final_snapshot_name str
    The final snapshot name which is taken before Serverless Cache is deleted.
    kms_key_id str
    The ID of the KMS key used to encrypt the cluster.
    major_engine_version str
    The major engine version of the Serverless Cache.
    reader_endpoint ServerlessCacheEndpointArgs
    security_group_ids Sequence[str]
    One or more Amazon VPC security groups associated with this Serverless Cache.
    serverless_cache_name str
    The name of the Serverless Cache. This value must be unique.
    snapshot_arns_to_restore Sequence[str]
    The ARN's of snapshot to restore Serverless Cache.
    snapshot_retention_limit int
    The snapshot retention limit of the Serverless Cache.
    subnet_ids Sequence[str]
    The subnet id's of the Serverless Cache.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this Serverless Cache.
    user_group_id str
    The ID of the user group.
    engine String
    The engine name of the Serverless Cache.
    cacheUsageLimits Property Map
    dailySnapshotTime String
    The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
    description String
    The description of the Serverless Cache.
    endpoint Property Map
    finalSnapshotName String
    The final snapshot name which is taken before Serverless Cache is deleted.
    kmsKeyId String
    The ID of the KMS key used to encrypt the cluster.
    majorEngineVersion String
    The major engine version of the Serverless Cache.
    readerEndpoint Property Map
    securityGroupIds List<String>
    One or more Amazon VPC security groups associated with this Serverless Cache.
    serverlessCacheName String
    The name of the Serverless Cache. This value must be unique.
    snapshotArnsToRestore List<String>
    The ARN's of snapshot to restore Serverless Cache.
    snapshotRetentionLimit Number
    The snapshot retention limit of the Serverless Cache.
    subnetIds List<String>
    The subnet id's of the Serverless Cache.
    tags List<Property Map>
    An array of key-value pairs to apply to this Serverless Cache.
    userGroupId String
    The ID of the user group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServerlessCache resource produces the following output properties:

    Arn string
    The ARN of the Serverless Cache.
    CreateTime string
    The creation time of the Serverless Cache.
    FullEngineVersion string
    The full engine version of the Serverless Cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Serverless Cache.
    Arn string
    The ARN of the Serverless Cache.
    CreateTime string
    The creation time of the Serverless Cache.
    FullEngineVersion string
    The full engine version of the Serverless Cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Serverless Cache.
    arn String
    The ARN of the Serverless Cache.
    createTime String
    The creation time of the Serverless Cache.
    fullEngineVersion String
    The full engine version of the Serverless Cache.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Serverless Cache.
    arn string
    The ARN of the Serverless Cache.
    createTime string
    The creation time of the Serverless Cache.
    fullEngineVersion string
    The full engine version of the Serverless Cache.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the Serverless Cache.
    arn str
    The ARN of the Serverless Cache.
    create_time str
    The creation time of the Serverless Cache.
    full_engine_version str
    The full engine version of the Serverless Cache.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the Serverless Cache.
    arn String
    The ARN of the Serverless Cache.
    createTime String
    The creation time of the Serverless Cache.
    fullEngineVersion String
    The full engine version of the Serverless Cache.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Serverless Cache.

    Supporting Types

    ServerlessCacheCacheUsageLimits, ServerlessCacheCacheUsageLimitsArgs

    ServerlessCacheDataStorage, ServerlessCacheDataStorageArgs

    Unit Pulumi.AwsNative.ElastiCache.ServerlessCacheDataStorageUnit
    The unit of cached data capacity of the Serverless Cache.
    Maximum int
    The maximum cached data capacity of the Serverless Cache.
    Minimum int
    The minimum cached data capacity of the Serverless Cache.
    Unit ServerlessCacheDataStorageUnit
    The unit of cached data capacity of the Serverless Cache.
    Maximum int
    The maximum cached data capacity of the Serverless Cache.
    Minimum int
    The minimum cached data capacity of the Serverless Cache.
    unit ServerlessCacheDataStorageUnit
    The unit of cached data capacity of the Serverless Cache.
    maximum Integer
    The maximum cached data capacity of the Serverless Cache.
    minimum Integer
    The minimum cached data capacity of the Serverless Cache.
    unit ServerlessCacheDataStorageUnit
    The unit of cached data capacity of the Serverless Cache.
    maximum number
    The maximum cached data capacity of the Serverless Cache.
    minimum number
    The minimum cached data capacity of the Serverless Cache.
    unit ServerlessCacheDataStorageUnit
    The unit of cached data capacity of the Serverless Cache.
    maximum int
    The maximum cached data capacity of the Serverless Cache.
    minimum int
    The minimum cached data capacity of the Serverless Cache.
    unit "GB"
    The unit of cached data capacity of the Serverless Cache.
    maximum Number
    The maximum cached data capacity of the Serverless Cache.
    minimum Number
    The minimum cached data capacity of the Serverless Cache.

    ServerlessCacheDataStorageUnit, ServerlessCacheDataStorageUnitArgs

    Gb
    GB
    ServerlessCacheDataStorageUnitGb
    GB
    Gb
    GB
    Gb
    GB
    GB
    GB
    "GB"
    GB

    ServerlessCacheEcpuPerSecond, ServerlessCacheEcpuPerSecondArgs

    Maximum int
    The maximum ECPU per second of the Serverless Cache.
    Minimum int
    The minimum ECPU per second of the Serverless Cache.
    Maximum int
    The maximum ECPU per second of the Serverless Cache.
    Minimum int
    The minimum ECPU per second of the Serverless Cache.
    maximum Integer
    The maximum ECPU per second of the Serverless Cache.
    minimum Integer
    The minimum ECPU per second of the Serverless Cache.
    maximum number
    The maximum ECPU per second of the Serverless Cache.
    minimum number
    The minimum ECPU per second of the Serverless Cache.
    maximum int
    The maximum ECPU per second of the Serverless Cache.
    minimum int
    The minimum ECPU per second of the Serverless Cache.
    maximum Number
    The maximum ECPU per second of the Serverless Cache.
    minimum Number
    The minimum ECPU per second of the Serverless Cache.

    ServerlessCacheEndpoint, ServerlessCacheEndpointArgs

    Address string
    Endpoint address.
    Port string
    Endpoint port.
    Address string
    Endpoint address.
    Port string
    Endpoint port.
    address String
    Endpoint address.
    port String
    Endpoint port.
    address string
    Endpoint address.
    port string
    Endpoint port.
    address str
    Endpoint address.
    port str
    Endpoint port.
    address String
    Endpoint address.
    port String
    Endpoint port.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native