redis

package
v1.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

nolint: lll

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cache

type Cache struct {
	pulumi.CustomResourceState

	// The size of the Redis cache to deploy. Valid values for a SKU `family` of C (Basic/Standard) are `0, 1, 2, 3, 4, 5, 6`, and for P (Premium) `family` are `1, 2, 3, 4`.
	Capacity pulumi.IntOutput `pulumi:"capacity"`
	// Enable the non-SSL port (6379) - disabled by default.
	EnableNonSslPort pulumi.BoolPtrOutput `pulumi:"enableNonSslPort"`
	// The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family pulumi.StringOutput `pulumi:"family"`
	// The Hostname of the Redis Instance
	Hostname pulumi.StringOutput `pulumi:"hostname"`
	// The location of the resource group.
	Location pulumi.StringOutput `pulumi:"location"`
	// The minimum TLS version.  Defaults to `1.0`.
	MinimumTlsVersion pulumi.StringPtrOutput `pulumi:"minimumTlsVersion"`
	// The name of the Redis instance. Changing this forces a
	// new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules CachePatchScheduleArrayOutput `pulumi:"patchSchedules"`
	// The non-SSL Port of the Redis Instance
	Port pulumi.IntOutput `pulumi:"port"`
	// The Primary Access Key for the Redis Instance
	PrimaryAccessKey pulumi.StringOutput `pulumi:"primaryAccessKey"`
	// The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
	PrivateStaticIpAddress pulumi.StringOutput `pulumi:"privateStaticIpAddress"`
	// A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.
	RedisConfiguration CacheRedisConfigurationOutput `pulumi:"redisConfiguration"`
	// The name of the resource group in which to
	// create the Redis instance.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The Secondary Access Key for the Redis Instance
	SecondaryAccessKey pulumi.StringOutput `pulumi:"secondaryAccessKey"`
	// *Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.
	ShardCount pulumi.IntPtrOutput `pulumi:"shardCount"`
	// The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// The SSL Port of the Redis Instance
	SslPort pulumi.IntOutput `pulumi:"sslPort"`
	// *Only available when using the Premium SKU* The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
	SubnetId pulumi.StringPtrOutput `pulumi:"subnetId"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A list of a single item of the Availability Zone which the Redis Cache should be allocated in.
	Zones pulumi.StringPtrOutput `pulumi:"zones"`
}

Manages a Redis Cache.

## Default Redis Configuration Values

| Redis Value | Basic | Standard | Premium | | ------------------------------- | ------------ | ------------ | ------------ | | enableAuthentication | true | true | true | | maxmemoryReserved | 2 | 50 | 200 | | maxfragmentationmemoryReserved | 2 | 50 | 200 | | maxmemoryDelta | 2 | 50 | 200 | | maxmemoryPolicy | volatile-lru | volatile-lru | volatile-lru |

> **NOTE:** The `maxmemoryReserved`, `maxmemoryDelta` and `maxfragmentationmemory-reserved` settings are only available for Standard and Premium caches. More details are available in the Relevant Links section below._

---

A `patchSchedule` block supports the following:

* `dayOfWeek` (Required) the Weekday name - possible values include `Monday`, `Tuesday`, `Wednesday` etc.

* `startHourUtc` - (Optional) the Start Hour for maintenance in UTC - possible values range from `0 - 23`.

> **Note:** The Patch Window lasts for `5` hours from the `startHourUtc`.

## Relevant Links

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/redis_cache.html.markdown.

func GetCache

func GetCache(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CacheState, opts ...pulumi.ResourceOption) (*Cache, error)

GetCache gets an existing Cache 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 NewCache

func NewCache(ctx *pulumi.Context,
	name string, args *CacheArgs, opts ...pulumi.ResourceOption) (*Cache, error)

NewCache registers a new resource with the given unique name, arguments, and options.

type CacheArgs

type CacheArgs struct {
	// The size of the Redis cache to deploy. Valid values for a SKU `family` of C (Basic/Standard) are `0, 1, 2, 3, 4, 5, 6`, and for P (Premium) `family` are `1, 2, 3, 4`.
	Capacity pulumi.IntInput
	// Enable the non-SSL port (6379) - disabled by default.
	EnableNonSslPort pulumi.BoolPtrInput
	// The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family pulumi.StringInput
	// The location of the resource group.
	Location pulumi.StringPtrInput
	// The minimum TLS version.  Defaults to `1.0`.
	MinimumTlsVersion pulumi.StringPtrInput
	// The name of the Redis instance. Changing this forces a
	// new resource to be created.
	Name pulumi.StringPtrInput
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules CachePatchScheduleArrayInput
	// The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
	PrivateStaticIpAddress pulumi.StringPtrInput
	// A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.
	RedisConfiguration CacheRedisConfigurationPtrInput
	// The name of the resource group in which to
	// create the Redis instance.
	ResourceGroupName pulumi.StringInput
	// *Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.
	ShardCount pulumi.IntPtrInput
	// The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName pulumi.StringInput
	// *Only available when using the Premium SKU* The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
	SubnetId pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// A list of a single item of the Availability Zone which the Redis Cache should be allocated in.
	Zones pulumi.StringPtrInput
}

The set of arguments for constructing a Cache resource.

func (CacheArgs) ElementType added in v1.12.0

func (CacheArgs) ElementType() reflect.Type

type CachePatchSchedule added in v1.12.0

type CachePatchSchedule struct {
	DayOfWeek    string `pulumi:"dayOfWeek"`
	StartHourUtc *int   `pulumi:"startHourUtc"`
}

type CachePatchScheduleArgs added in v1.12.0

type CachePatchScheduleArgs struct {
	DayOfWeek    pulumi.StringInput `pulumi:"dayOfWeek"`
	StartHourUtc pulumi.IntPtrInput `pulumi:"startHourUtc"`
}

func (CachePatchScheduleArgs) ElementType added in v1.12.0

func (CachePatchScheduleArgs) ElementType() reflect.Type

func (CachePatchScheduleArgs) ToCachePatchScheduleOutput added in v1.12.0

func (i CachePatchScheduleArgs) ToCachePatchScheduleOutput() CachePatchScheduleOutput

func (CachePatchScheduleArgs) ToCachePatchScheduleOutputWithContext added in v1.12.0

func (i CachePatchScheduleArgs) ToCachePatchScheduleOutputWithContext(ctx context.Context) CachePatchScheduleOutput

type CachePatchScheduleArray added in v1.12.0

type CachePatchScheduleArray []CachePatchScheduleInput

func (CachePatchScheduleArray) ElementType added in v1.12.0

func (CachePatchScheduleArray) ElementType() reflect.Type

func (CachePatchScheduleArray) ToCachePatchScheduleArrayOutput added in v1.12.0

func (i CachePatchScheduleArray) ToCachePatchScheduleArrayOutput() CachePatchScheduleArrayOutput

func (CachePatchScheduleArray) ToCachePatchScheduleArrayOutputWithContext added in v1.12.0

func (i CachePatchScheduleArray) ToCachePatchScheduleArrayOutputWithContext(ctx context.Context) CachePatchScheduleArrayOutput

type CachePatchScheduleArrayInput added in v1.12.0

type CachePatchScheduleArrayInput interface {
	pulumi.Input

	ToCachePatchScheduleArrayOutput() CachePatchScheduleArrayOutput
	ToCachePatchScheduleArrayOutputWithContext(context.Context) CachePatchScheduleArrayOutput
}

type CachePatchScheduleArrayOutput added in v1.12.0

type CachePatchScheduleArrayOutput struct{ *pulumi.OutputState }

func (CachePatchScheduleArrayOutput) ElementType added in v1.12.0

func (CachePatchScheduleArrayOutput) Index added in v1.12.0

func (CachePatchScheduleArrayOutput) ToCachePatchScheduleArrayOutput added in v1.12.0

func (o CachePatchScheduleArrayOutput) ToCachePatchScheduleArrayOutput() CachePatchScheduleArrayOutput

func (CachePatchScheduleArrayOutput) ToCachePatchScheduleArrayOutputWithContext added in v1.12.0

func (o CachePatchScheduleArrayOutput) ToCachePatchScheduleArrayOutputWithContext(ctx context.Context) CachePatchScheduleArrayOutput

type CachePatchScheduleInput added in v1.12.0

type CachePatchScheduleInput interface {
	pulumi.Input

	ToCachePatchScheduleOutput() CachePatchScheduleOutput
	ToCachePatchScheduleOutputWithContext(context.Context) CachePatchScheduleOutput
}

type CachePatchScheduleOutput added in v1.12.0

type CachePatchScheduleOutput struct{ *pulumi.OutputState }

func (CachePatchScheduleOutput) DayOfWeek added in v1.12.0

func (CachePatchScheduleOutput) ElementType added in v1.12.0

func (CachePatchScheduleOutput) ElementType() reflect.Type

func (CachePatchScheduleOutput) StartHourUtc added in v1.12.0

func (o CachePatchScheduleOutput) StartHourUtc() pulumi.IntPtrOutput

func (CachePatchScheduleOutput) ToCachePatchScheduleOutput added in v1.12.0

func (o CachePatchScheduleOutput) ToCachePatchScheduleOutput() CachePatchScheduleOutput

func (CachePatchScheduleOutput) ToCachePatchScheduleOutputWithContext added in v1.12.0

func (o CachePatchScheduleOutput) ToCachePatchScheduleOutputWithContext(ctx context.Context) CachePatchScheduleOutput

type CacheRedisConfiguration added in v1.12.0

type CacheRedisConfiguration struct {
	AofBackupEnabled            *bool   `pulumi:"aofBackupEnabled"`
	AofStorageConnectionString0 *string `pulumi:"aofStorageConnectionString0"`
	AofStorageConnectionString1 *string `pulumi:"aofStorageConnectionString1"`
	EnableAuthentication        *bool   `pulumi:"enableAuthentication"`
	// Returns the max number of connected clients at the same time.
	Maxclients                     *int    `pulumi:"maxclients"`
	MaxfragmentationmemoryReserved *int    `pulumi:"maxfragmentationmemoryReserved"`
	MaxmemoryDelta                 *int    `pulumi:"maxmemoryDelta"`
	MaxmemoryPolicy                *string `pulumi:"maxmemoryPolicy"`
	MaxmemoryReserved              *int    `pulumi:"maxmemoryReserved"`
	NotifyKeyspaceEvents           *string `pulumi:"notifyKeyspaceEvents"`
	RdbBackupEnabled               *bool   `pulumi:"rdbBackupEnabled"`
	RdbBackupFrequency             *int    `pulumi:"rdbBackupFrequency"`
	RdbBackupMaxSnapshotCount      *int    `pulumi:"rdbBackupMaxSnapshotCount"`
	RdbStorageConnectionString     *string `pulumi:"rdbStorageConnectionString"`
}

type CacheRedisConfigurationArgs added in v1.12.0

type CacheRedisConfigurationArgs struct {
	AofBackupEnabled            pulumi.BoolPtrInput   `pulumi:"aofBackupEnabled"`
	AofStorageConnectionString0 pulumi.StringPtrInput `pulumi:"aofStorageConnectionString0"`
	AofStorageConnectionString1 pulumi.StringPtrInput `pulumi:"aofStorageConnectionString1"`
	EnableAuthentication        pulumi.BoolPtrInput   `pulumi:"enableAuthentication"`
	// Returns the max number of connected clients at the same time.
	Maxclients                     pulumi.IntPtrInput    `pulumi:"maxclients"`
	MaxfragmentationmemoryReserved pulumi.IntPtrInput    `pulumi:"maxfragmentationmemoryReserved"`
	MaxmemoryDelta                 pulumi.IntPtrInput    `pulumi:"maxmemoryDelta"`
	MaxmemoryPolicy                pulumi.StringPtrInput `pulumi:"maxmemoryPolicy"`
	MaxmemoryReserved              pulumi.IntPtrInput    `pulumi:"maxmemoryReserved"`
	NotifyKeyspaceEvents           pulumi.StringPtrInput `pulumi:"notifyKeyspaceEvents"`
	RdbBackupEnabled               pulumi.BoolPtrInput   `pulumi:"rdbBackupEnabled"`
	RdbBackupFrequency             pulumi.IntPtrInput    `pulumi:"rdbBackupFrequency"`
	RdbBackupMaxSnapshotCount      pulumi.IntPtrInput    `pulumi:"rdbBackupMaxSnapshotCount"`
	RdbStorageConnectionString     pulumi.StringPtrInput `pulumi:"rdbStorageConnectionString"`
}

func (CacheRedisConfigurationArgs) ElementType added in v1.12.0

func (CacheRedisConfigurationArgs) ToCacheRedisConfigurationOutput added in v1.12.0

func (i CacheRedisConfigurationArgs) ToCacheRedisConfigurationOutput() CacheRedisConfigurationOutput

func (CacheRedisConfigurationArgs) ToCacheRedisConfigurationOutputWithContext added in v1.12.0

func (i CacheRedisConfigurationArgs) ToCacheRedisConfigurationOutputWithContext(ctx context.Context) CacheRedisConfigurationOutput

func (CacheRedisConfigurationArgs) ToCacheRedisConfigurationPtrOutput added in v1.12.0

func (i CacheRedisConfigurationArgs) ToCacheRedisConfigurationPtrOutput() CacheRedisConfigurationPtrOutput

func (CacheRedisConfigurationArgs) ToCacheRedisConfigurationPtrOutputWithContext added in v1.12.0

func (i CacheRedisConfigurationArgs) ToCacheRedisConfigurationPtrOutputWithContext(ctx context.Context) CacheRedisConfigurationPtrOutput

type CacheRedisConfigurationInput added in v1.12.0

type CacheRedisConfigurationInput interface {
	pulumi.Input

	ToCacheRedisConfigurationOutput() CacheRedisConfigurationOutput
	ToCacheRedisConfigurationOutputWithContext(context.Context) CacheRedisConfigurationOutput
}

type CacheRedisConfigurationOutput added in v1.12.0

type CacheRedisConfigurationOutput struct{ *pulumi.OutputState }

func (CacheRedisConfigurationOutput) AofBackupEnabled added in v1.12.0

func (o CacheRedisConfigurationOutput) AofBackupEnabled() pulumi.BoolPtrOutput

func (CacheRedisConfigurationOutput) AofStorageConnectionString0 added in v1.12.0

func (o CacheRedisConfigurationOutput) AofStorageConnectionString0() pulumi.StringPtrOutput

func (CacheRedisConfigurationOutput) AofStorageConnectionString1 added in v1.12.0

func (o CacheRedisConfigurationOutput) AofStorageConnectionString1() pulumi.StringPtrOutput

func (CacheRedisConfigurationOutput) ElementType added in v1.12.0

func (CacheRedisConfigurationOutput) EnableAuthentication added in v1.12.0

func (o CacheRedisConfigurationOutput) EnableAuthentication() pulumi.BoolPtrOutput

func (CacheRedisConfigurationOutput) Maxclients added in v1.12.0

Returns the max number of connected clients at the same time.

func (CacheRedisConfigurationOutput) MaxfragmentationmemoryReserved added in v1.12.0

func (o CacheRedisConfigurationOutput) MaxfragmentationmemoryReserved() pulumi.IntPtrOutput

func (CacheRedisConfigurationOutput) MaxmemoryDelta added in v1.12.0

func (CacheRedisConfigurationOutput) MaxmemoryPolicy added in v1.12.0

func (CacheRedisConfigurationOutput) MaxmemoryReserved added in v1.12.0

func (o CacheRedisConfigurationOutput) MaxmemoryReserved() pulumi.IntPtrOutput

func (CacheRedisConfigurationOutput) NotifyKeyspaceEvents added in v1.12.0

func (o CacheRedisConfigurationOutput) NotifyKeyspaceEvents() pulumi.StringPtrOutput

func (CacheRedisConfigurationOutput) RdbBackupEnabled added in v1.12.0

func (o CacheRedisConfigurationOutput) RdbBackupEnabled() pulumi.BoolPtrOutput

func (CacheRedisConfigurationOutput) RdbBackupFrequency added in v1.12.0

func (o CacheRedisConfigurationOutput) RdbBackupFrequency() pulumi.IntPtrOutput

func (CacheRedisConfigurationOutput) RdbBackupMaxSnapshotCount added in v1.12.0

func (o CacheRedisConfigurationOutput) RdbBackupMaxSnapshotCount() pulumi.IntPtrOutput

func (CacheRedisConfigurationOutput) RdbStorageConnectionString added in v1.12.0

func (o CacheRedisConfigurationOutput) RdbStorageConnectionString() pulumi.StringPtrOutput

func (CacheRedisConfigurationOutput) ToCacheRedisConfigurationOutput added in v1.12.0

func (o CacheRedisConfigurationOutput) ToCacheRedisConfigurationOutput() CacheRedisConfigurationOutput

func (CacheRedisConfigurationOutput) ToCacheRedisConfigurationOutputWithContext added in v1.12.0

func (o CacheRedisConfigurationOutput) ToCacheRedisConfigurationOutputWithContext(ctx context.Context) CacheRedisConfigurationOutput

func (CacheRedisConfigurationOutput) ToCacheRedisConfigurationPtrOutput added in v1.12.0

func (o CacheRedisConfigurationOutput) ToCacheRedisConfigurationPtrOutput() CacheRedisConfigurationPtrOutput

func (CacheRedisConfigurationOutput) ToCacheRedisConfigurationPtrOutputWithContext added in v1.12.0

func (o CacheRedisConfigurationOutput) ToCacheRedisConfigurationPtrOutputWithContext(ctx context.Context) CacheRedisConfigurationPtrOutput

type CacheRedisConfigurationPtrInput added in v1.12.0

type CacheRedisConfigurationPtrInput interface {
	pulumi.Input

	ToCacheRedisConfigurationPtrOutput() CacheRedisConfigurationPtrOutput
	ToCacheRedisConfigurationPtrOutputWithContext(context.Context) CacheRedisConfigurationPtrOutput
}

func CacheRedisConfigurationPtr added in v1.12.0

func CacheRedisConfigurationPtr(v *CacheRedisConfigurationArgs) CacheRedisConfigurationPtrInput

type CacheRedisConfigurationPtrOutput added in v1.12.0

type CacheRedisConfigurationPtrOutput struct{ *pulumi.OutputState }

func (CacheRedisConfigurationPtrOutput) AofBackupEnabled added in v1.12.0

func (CacheRedisConfigurationPtrOutput) AofStorageConnectionString0 added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) AofStorageConnectionString0() pulumi.StringPtrOutput

func (CacheRedisConfigurationPtrOutput) AofStorageConnectionString1 added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) AofStorageConnectionString1() pulumi.StringPtrOutput

func (CacheRedisConfigurationPtrOutput) Elem added in v1.12.0

func (CacheRedisConfigurationPtrOutput) ElementType added in v1.12.0

func (CacheRedisConfigurationPtrOutput) EnableAuthentication added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) EnableAuthentication() pulumi.BoolPtrOutput

func (CacheRedisConfigurationPtrOutput) Maxclients added in v1.12.0

Returns the max number of connected clients at the same time.

func (CacheRedisConfigurationPtrOutput) MaxfragmentationmemoryReserved added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) MaxfragmentationmemoryReserved() pulumi.IntPtrOutput

func (CacheRedisConfigurationPtrOutput) MaxmemoryDelta added in v1.12.0

func (CacheRedisConfigurationPtrOutput) MaxmemoryPolicy added in v1.12.0

func (CacheRedisConfigurationPtrOutput) MaxmemoryReserved added in v1.12.0

func (CacheRedisConfigurationPtrOutput) NotifyKeyspaceEvents added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) NotifyKeyspaceEvents() pulumi.StringPtrOutput

func (CacheRedisConfigurationPtrOutput) RdbBackupEnabled added in v1.12.0

func (CacheRedisConfigurationPtrOutput) RdbBackupFrequency added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) RdbBackupFrequency() pulumi.IntPtrOutput

func (CacheRedisConfigurationPtrOutput) RdbBackupMaxSnapshotCount added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) RdbBackupMaxSnapshotCount() pulumi.IntPtrOutput

func (CacheRedisConfigurationPtrOutput) RdbStorageConnectionString added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) RdbStorageConnectionString() pulumi.StringPtrOutput

func (CacheRedisConfigurationPtrOutput) ToCacheRedisConfigurationPtrOutput added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) ToCacheRedisConfigurationPtrOutput() CacheRedisConfigurationPtrOutput

func (CacheRedisConfigurationPtrOutput) ToCacheRedisConfigurationPtrOutputWithContext added in v1.12.0

func (o CacheRedisConfigurationPtrOutput) ToCacheRedisConfigurationPtrOutputWithContext(ctx context.Context) CacheRedisConfigurationPtrOutput

type CacheState

type CacheState struct {
	// The size of the Redis cache to deploy. Valid values for a SKU `family` of C (Basic/Standard) are `0, 1, 2, 3, 4, 5, 6`, and for P (Premium) `family` are `1, 2, 3, 4`.
	Capacity pulumi.IntPtrInput
	// Enable the non-SSL port (6379) - disabled by default.
	EnableNonSslPort pulumi.BoolPtrInput
	// The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family pulumi.StringPtrInput
	// The Hostname of the Redis Instance
	Hostname pulumi.StringPtrInput
	// The location of the resource group.
	Location pulumi.StringPtrInput
	// The minimum TLS version.  Defaults to `1.0`.
	MinimumTlsVersion pulumi.StringPtrInput
	// The name of the Redis instance. Changing this forces a
	// new resource to be created.
	Name pulumi.StringPtrInput
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules CachePatchScheduleArrayInput
	// The non-SSL Port of the Redis Instance
	Port pulumi.IntPtrInput
	// The Primary Access Key for the Redis Instance
	PrimaryAccessKey pulumi.StringPtrInput
	// The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
	PrivateStaticIpAddress pulumi.StringPtrInput
	// A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.
	RedisConfiguration CacheRedisConfigurationPtrInput
	// The name of the resource group in which to
	// create the Redis instance.
	ResourceGroupName pulumi.StringPtrInput
	// The Secondary Access Key for the Redis Instance
	SecondaryAccessKey pulumi.StringPtrInput
	// *Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.
	ShardCount pulumi.IntPtrInput
	// The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName pulumi.StringPtrInput
	// The SSL Port of the Redis Instance
	SslPort pulumi.IntPtrInput
	// *Only available when using the Premium SKU* The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
	SubnetId pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// A list of a single item of the Availability Zone which the Redis Cache should be allocated in.
	Zones pulumi.StringPtrInput
}

func (CacheState) ElementType added in v1.12.0

func (CacheState) ElementType() reflect.Type

type FirewallRule

type FirewallRule struct {
	pulumi.CustomResourceState

	// The highest IP address included in the range.
	EndIp pulumi.StringOutput `pulumi:"endIp"`
	// The name of the Firewall Rule. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the Redis Cache. Changing this forces a new resource to be created.
	RedisCacheName pulumi.StringOutput `pulumi:"redisCacheName"`
	// The name of the resource group in which this Redis Cache exists.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The lowest IP address included in the range
	StartIp pulumi.StringOutput `pulumi:"startIp"`
}

Manages a Firewall Rule associated with a Redis Cache.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/redis_firewall_rule.html.markdown.

func GetFirewallRule

func GetFirewallRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FirewallRuleState, opts ...pulumi.ResourceOption) (*FirewallRule, error)

GetFirewallRule gets an existing FirewallRule 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 NewFirewallRule

func NewFirewallRule(ctx *pulumi.Context,
	name string, args *FirewallRuleArgs, opts ...pulumi.ResourceOption) (*FirewallRule, error)

NewFirewallRule registers a new resource with the given unique name, arguments, and options.

type FirewallRuleArgs

type FirewallRuleArgs struct {
	// The highest IP address included in the range.
	EndIp pulumi.StringInput
	// The name of the Firewall Rule. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Redis Cache. Changing this forces a new resource to be created.
	RedisCacheName pulumi.StringInput
	// The name of the resource group in which this Redis Cache exists.
	ResourceGroupName pulumi.StringInput
	// The lowest IP address included in the range
	StartIp pulumi.StringInput
}

The set of arguments for constructing a FirewallRule resource.

func (FirewallRuleArgs) ElementType added in v1.12.0

func (FirewallRuleArgs) ElementType() reflect.Type

type FirewallRuleState

type FirewallRuleState struct {
	// The highest IP address included in the range.
	EndIp pulumi.StringPtrInput
	// The name of the Firewall Rule. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Redis Cache. Changing this forces a new resource to be created.
	RedisCacheName pulumi.StringPtrInput
	// The name of the resource group in which this Redis Cache exists.
	ResourceGroupName pulumi.StringPtrInput
	// The lowest IP address included in the range
	StartIp pulumi.StringPtrInput
}

func (FirewallRuleState) ElementType added in v1.12.0

func (FirewallRuleState) ElementType() reflect.Type

type GetCachePatchSchedule added in v1.12.0

type GetCachePatchSchedule struct {
	// the Weekday name for the patch item
	DayOfWeek string `pulumi:"dayOfWeek"`
	// The Start Hour for maintenance in UTC
	StartHourUtc int `pulumi:"startHourUtc"`
}

type GetCachePatchScheduleArgs added in v1.12.0

type GetCachePatchScheduleArgs struct {
	// the Weekday name for the patch item
	DayOfWeek pulumi.StringInput `pulumi:"dayOfWeek"`
	// The Start Hour for maintenance in UTC
	StartHourUtc pulumi.IntInput `pulumi:"startHourUtc"`
}

func (GetCachePatchScheduleArgs) ElementType added in v1.12.0

func (GetCachePatchScheduleArgs) ElementType() reflect.Type

func (GetCachePatchScheduleArgs) ToGetCachePatchScheduleOutput added in v1.12.0

func (i GetCachePatchScheduleArgs) ToGetCachePatchScheduleOutput() GetCachePatchScheduleOutput

func (GetCachePatchScheduleArgs) ToGetCachePatchScheduleOutputWithContext added in v1.12.0

func (i GetCachePatchScheduleArgs) ToGetCachePatchScheduleOutputWithContext(ctx context.Context) GetCachePatchScheduleOutput

type GetCachePatchScheduleArray added in v1.12.0

type GetCachePatchScheduleArray []GetCachePatchScheduleInput

func (GetCachePatchScheduleArray) ElementType added in v1.12.0

func (GetCachePatchScheduleArray) ElementType() reflect.Type

func (GetCachePatchScheduleArray) ToGetCachePatchScheduleArrayOutput added in v1.12.0

func (i GetCachePatchScheduleArray) ToGetCachePatchScheduleArrayOutput() GetCachePatchScheduleArrayOutput

func (GetCachePatchScheduleArray) ToGetCachePatchScheduleArrayOutputWithContext added in v1.12.0

func (i GetCachePatchScheduleArray) ToGetCachePatchScheduleArrayOutputWithContext(ctx context.Context) GetCachePatchScheduleArrayOutput

type GetCachePatchScheduleArrayInput added in v1.12.0

type GetCachePatchScheduleArrayInput interface {
	pulumi.Input

	ToGetCachePatchScheduleArrayOutput() GetCachePatchScheduleArrayOutput
	ToGetCachePatchScheduleArrayOutputWithContext(context.Context) GetCachePatchScheduleArrayOutput
}

type GetCachePatchScheduleArrayOutput added in v1.12.0

type GetCachePatchScheduleArrayOutput struct{ *pulumi.OutputState }

func (GetCachePatchScheduleArrayOutput) ElementType added in v1.12.0

func (GetCachePatchScheduleArrayOutput) Index added in v1.12.0

func (GetCachePatchScheduleArrayOutput) ToGetCachePatchScheduleArrayOutput added in v1.12.0

func (o GetCachePatchScheduleArrayOutput) ToGetCachePatchScheduleArrayOutput() GetCachePatchScheduleArrayOutput

func (GetCachePatchScheduleArrayOutput) ToGetCachePatchScheduleArrayOutputWithContext added in v1.12.0

func (o GetCachePatchScheduleArrayOutput) ToGetCachePatchScheduleArrayOutputWithContext(ctx context.Context) GetCachePatchScheduleArrayOutput

type GetCachePatchScheduleInput added in v1.12.0

type GetCachePatchScheduleInput interface {
	pulumi.Input

	ToGetCachePatchScheduleOutput() GetCachePatchScheduleOutput
	ToGetCachePatchScheduleOutputWithContext(context.Context) GetCachePatchScheduleOutput
}

type GetCachePatchScheduleOutput added in v1.12.0

type GetCachePatchScheduleOutput struct{ *pulumi.OutputState }

func (GetCachePatchScheduleOutput) DayOfWeek added in v1.12.0

the Weekday name for the patch item

func (GetCachePatchScheduleOutput) ElementType added in v1.12.0

func (GetCachePatchScheduleOutput) StartHourUtc added in v1.12.0

func (o GetCachePatchScheduleOutput) StartHourUtc() pulumi.IntOutput

The Start Hour for maintenance in UTC

func (GetCachePatchScheduleOutput) ToGetCachePatchScheduleOutput added in v1.12.0

func (o GetCachePatchScheduleOutput) ToGetCachePatchScheduleOutput() GetCachePatchScheduleOutput

func (GetCachePatchScheduleOutput) ToGetCachePatchScheduleOutputWithContext added in v1.12.0

func (o GetCachePatchScheduleOutput) ToGetCachePatchScheduleOutputWithContext(ctx context.Context) GetCachePatchScheduleOutput

type GetCacheRedisConfiguration added in v1.12.0

type GetCacheRedisConfiguration struct {
	AofBackupEnabled            bool   `pulumi:"aofBackupEnabled"`
	AofStorageConnectionString0 string `pulumi:"aofStorageConnectionString0"`
	AofStorageConnectionString1 string `pulumi:"aofStorageConnectionString1"`
	// Specifies if authentication is enabled
	EnableAuthentication bool `pulumi:"enableAuthentication"`
	Maxclients           int  `pulumi:"maxclients"`
	// Value in megabytes reserved to accommodate for memory fragmentation.
	MaxfragmentationmemoryReserved int `pulumi:"maxfragmentationmemoryReserved"`
	// The max-memory delta for this Redis instance.
	MaxmemoryDelta int `pulumi:"maxmemoryDelta"`
	// How Redis will select what to remove when `maxmemory` is reached.
	MaxmemoryPolicy string `pulumi:"maxmemoryPolicy"`
	// The value in megabytes reserved for non-cache usage e.g. failover
	MaxmemoryReserved    int    `pulumi:"maxmemoryReserved"`
	NotifyKeyspaceEvents string `pulumi:"notifyKeyspaceEvents"`
	// Is Backup Enabled? Only supported on Premium SKU's.
	RdbBackupEnabled bool `pulumi:"rdbBackupEnabled"`
	// The Backup Frequency in Minutes. Only supported on Premium SKU's.
	RdbBackupFrequency int `pulumi:"rdbBackupFrequency"`
	// The maximum number of snapshots that can be created as a backup.
	RdbBackupMaxSnapshotCount int `pulumi:"rdbBackupMaxSnapshotCount"`
	// The Connection String to the Storage Account. Only supported for Premium SKU's.
	RdbStorageConnectionString string `pulumi:"rdbStorageConnectionString"`
}

type GetCacheRedisConfigurationArgs added in v1.12.0

type GetCacheRedisConfigurationArgs struct {
	AofBackupEnabled            pulumi.BoolInput   `pulumi:"aofBackupEnabled"`
	AofStorageConnectionString0 pulumi.StringInput `pulumi:"aofStorageConnectionString0"`
	AofStorageConnectionString1 pulumi.StringInput `pulumi:"aofStorageConnectionString1"`
	// Specifies if authentication is enabled
	EnableAuthentication pulumi.BoolInput `pulumi:"enableAuthentication"`
	Maxclients           pulumi.IntInput  `pulumi:"maxclients"`
	// Value in megabytes reserved to accommodate for memory fragmentation.
	MaxfragmentationmemoryReserved pulumi.IntInput `pulumi:"maxfragmentationmemoryReserved"`
	// The max-memory delta for this Redis instance.
	MaxmemoryDelta pulumi.IntInput `pulumi:"maxmemoryDelta"`
	// How Redis will select what to remove when `maxmemory` is reached.
	MaxmemoryPolicy pulumi.StringInput `pulumi:"maxmemoryPolicy"`
	// The value in megabytes reserved for non-cache usage e.g. failover
	MaxmemoryReserved    pulumi.IntInput    `pulumi:"maxmemoryReserved"`
	NotifyKeyspaceEvents pulumi.StringInput `pulumi:"notifyKeyspaceEvents"`
	// Is Backup Enabled? Only supported on Premium SKU's.
	RdbBackupEnabled pulumi.BoolInput `pulumi:"rdbBackupEnabled"`
	// The Backup Frequency in Minutes. Only supported on Premium SKU's.
	RdbBackupFrequency pulumi.IntInput `pulumi:"rdbBackupFrequency"`
	// The maximum number of snapshots that can be created as a backup.
	RdbBackupMaxSnapshotCount pulumi.IntInput `pulumi:"rdbBackupMaxSnapshotCount"`
	// The Connection String to the Storage Account. Only supported for Premium SKU's.
	RdbStorageConnectionString pulumi.StringInput `pulumi:"rdbStorageConnectionString"`
}

func (GetCacheRedisConfigurationArgs) ElementType added in v1.12.0

func (GetCacheRedisConfigurationArgs) ToGetCacheRedisConfigurationOutput added in v1.12.0

func (i GetCacheRedisConfigurationArgs) ToGetCacheRedisConfigurationOutput() GetCacheRedisConfigurationOutput

func (GetCacheRedisConfigurationArgs) ToGetCacheRedisConfigurationOutputWithContext added in v1.12.0

func (i GetCacheRedisConfigurationArgs) ToGetCacheRedisConfigurationOutputWithContext(ctx context.Context) GetCacheRedisConfigurationOutput

type GetCacheRedisConfigurationArray added in v1.12.0

type GetCacheRedisConfigurationArray []GetCacheRedisConfigurationInput

func (GetCacheRedisConfigurationArray) ElementType added in v1.12.0

func (GetCacheRedisConfigurationArray) ToGetCacheRedisConfigurationArrayOutput added in v1.12.0

func (i GetCacheRedisConfigurationArray) ToGetCacheRedisConfigurationArrayOutput() GetCacheRedisConfigurationArrayOutput

func (GetCacheRedisConfigurationArray) ToGetCacheRedisConfigurationArrayOutputWithContext added in v1.12.0

func (i GetCacheRedisConfigurationArray) ToGetCacheRedisConfigurationArrayOutputWithContext(ctx context.Context) GetCacheRedisConfigurationArrayOutput

type GetCacheRedisConfigurationArrayInput added in v1.12.0

type GetCacheRedisConfigurationArrayInput interface {
	pulumi.Input

	ToGetCacheRedisConfigurationArrayOutput() GetCacheRedisConfigurationArrayOutput
	ToGetCacheRedisConfigurationArrayOutputWithContext(context.Context) GetCacheRedisConfigurationArrayOutput
}

type GetCacheRedisConfigurationArrayOutput added in v1.12.0

type GetCacheRedisConfigurationArrayOutput struct{ *pulumi.OutputState }

func (GetCacheRedisConfigurationArrayOutput) ElementType added in v1.12.0

func (GetCacheRedisConfigurationArrayOutput) Index added in v1.12.0

func (GetCacheRedisConfigurationArrayOutput) ToGetCacheRedisConfigurationArrayOutput added in v1.12.0

func (o GetCacheRedisConfigurationArrayOutput) ToGetCacheRedisConfigurationArrayOutput() GetCacheRedisConfigurationArrayOutput

func (GetCacheRedisConfigurationArrayOutput) ToGetCacheRedisConfigurationArrayOutputWithContext added in v1.12.0

func (o GetCacheRedisConfigurationArrayOutput) ToGetCacheRedisConfigurationArrayOutputWithContext(ctx context.Context) GetCacheRedisConfigurationArrayOutput

type GetCacheRedisConfigurationInput added in v1.12.0

type GetCacheRedisConfigurationInput interface {
	pulumi.Input

	ToGetCacheRedisConfigurationOutput() GetCacheRedisConfigurationOutput
	ToGetCacheRedisConfigurationOutputWithContext(context.Context) GetCacheRedisConfigurationOutput
}

type GetCacheRedisConfigurationOutput added in v1.12.0

type GetCacheRedisConfigurationOutput struct{ *pulumi.OutputState }

func (GetCacheRedisConfigurationOutput) AofBackupEnabled added in v1.12.0

func (o GetCacheRedisConfigurationOutput) AofBackupEnabled() pulumi.BoolOutput

func (GetCacheRedisConfigurationOutput) AofStorageConnectionString0 added in v1.12.0

func (o GetCacheRedisConfigurationOutput) AofStorageConnectionString0() pulumi.StringOutput

func (GetCacheRedisConfigurationOutput) AofStorageConnectionString1 added in v1.12.0

func (o GetCacheRedisConfigurationOutput) AofStorageConnectionString1() pulumi.StringOutput

func (GetCacheRedisConfigurationOutput) ElementType added in v1.12.0

func (GetCacheRedisConfigurationOutput) EnableAuthentication added in v1.12.0

func (o GetCacheRedisConfigurationOutput) EnableAuthentication() pulumi.BoolOutput

Specifies if authentication is enabled

func (GetCacheRedisConfigurationOutput) Maxclients added in v1.12.0

func (GetCacheRedisConfigurationOutput) MaxfragmentationmemoryReserved added in v1.12.0

func (o GetCacheRedisConfigurationOutput) MaxfragmentationmemoryReserved() pulumi.IntOutput

Value in megabytes reserved to accommodate for memory fragmentation.

func (GetCacheRedisConfigurationOutput) MaxmemoryDelta added in v1.12.0

The max-memory delta for this Redis instance.

func (GetCacheRedisConfigurationOutput) MaxmemoryPolicy added in v1.12.0

How Redis will select what to remove when `maxmemory` is reached.

func (GetCacheRedisConfigurationOutput) MaxmemoryReserved added in v1.12.0

func (o GetCacheRedisConfigurationOutput) MaxmemoryReserved() pulumi.IntOutput

The value in megabytes reserved for non-cache usage e.g. failover

func (GetCacheRedisConfigurationOutput) NotifyKeyspaceEvents added in v1.12.0

func (o GetCacheRedisConfigurationOutput) NotifyKeyspaceEvents() pulumi.StringOutput

func (GetCacheRedisConfigurationOutput) RdbBackupEnabled added in v1.12.0

func (o GetCacheRedisConfigurationOutput) RdbBackupEnabled() pulumi.BoolOutput

Is Backup Enabled? Only supported on Premium SKU's.

func (GetCacheRedisConfigurationOutput) RdbBackupFrequency added in v1.12.0

func (o GetCacheRedisConfigurationOutput) RdbBackupFrequency() pulumi.IntOutput

The Backup Frequency in Minutes. Only supported on Premium SKU's.

func (GetCacheRedisConfigurationOutput) RdbBackupMaxSnapshotCount added in v1.12.0

func (o GetCacheRedisConfigurationOutput) RdbBackupMaxSnapshotCount() pulumi.IntOutput

The maximum number of snapshots that can be created as a backup.

func (GetCacheRedisConfigurationOutput) RdbStorageConnectionString added in v1.12.0

func (o GetCacheRedisConfigurationOutput) RdbStorageConnectionString() pulumi.StringOutput

The Connection String to the Storage Account. Only supported for Premium SKU's.

func (GetCacheRedisConfigurationOutput) ToGetCacheRedisConfigurationOutput added in v1.12.0

func (o GetCacheRedisConfigurationOutput) ToGetCacheRedisConfigurationOutput() GetCacheRedisConfigurationOutput

func (GetCacheRedisConfigurationOutput) ToGetCacheRedisConfigurationOutputWithContext added in v1.12.0

func (o GetCacheRedisConfigurationOutput) ToGetCacheRedisConfigurationOutputWithContext(ctx context.Context) GetCacheRedisConfigurationOutput

type LookupCacheArgs added in v1.12.0

type LookupCacheArgs struct {
	// The name of the Redis cache
	Name string `pulumi:"name"`
	// The name of the resource group the Redis cache instance is located in.
	ResourceGroupName string   `pulumi:"resourceGroupName"`
	Zones             []string `pulumi:"zones"`
}

A collection of arguments for invoking getCache.

type LookupCacheResult added in v1.12.0

type LookupCacheResult struct {
	// The size of the Redis Cache deployed.
	Capacity int `pulumi:"capacity"`
	// Whether the SSL port is enabled.
	EnableNonSslPort bool `pulumi:"enableNonSslPort"`
	// The SKU family/pricing group used. Possible values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family string `pulumi:"family"`
	// The Hostname of the Redis Instance
	Hostname string `pulumi:"hostname"`
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The location of the Redis Cache.
	Location string `pulumi:"location"`
	// The minimum TLS version.
	MinimumTlsVersion string `pulumi:"minimumTlsVersion"`
	Name              string `pulumi:"name"`
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules []GetCachePatchSchedule `pulumi:"patchSchedules"`
	// The non-SSL Port of the Redis Instance
	Port int `pulumi:"port"`
	// The Primary Access Key for the Redis Instance
	PrimaryAccessKey       string `pulumi:"primaryAccessKey"`
	PrivateStaticIpAddress string `pulumi:"privateStaticIpAddress"`
	// A `redisConfiguration` block as defined below.
	RedisConfigurations []GetCacheRedisConfiguration `pulumi:"redisConfigurations"`
	ResourceGroupName   string                       `pulumi:"resourceGroupName"`
	// The Secondary Access Key for the Redis Instance
	SecondaryAccessKey string `pulumi:"secondaryAccessKey"`
	ShardCount         int    `pulumi:"shardCount"`
	// The SKU of Redis used. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName string `pulumi:"skuName"`
	// The SSL Port of the Redis Instance
	SslPort  int               `pulumi:"sslPort"`
	SubnetId string            `pulumi:"subnetId"`
	Tags     map[string]string `pulumi:"tags"`
	Zones    []string          `pulumi:"zones"`
}

A collection of values returned by getCache.

func LookupCache added in v0.18.6

func LookupCache(ctx *pulumi.Context, args *LookupCacheArgs, opts ...pulumi.InvokeOption) (*LookupCacheResult, error)

Use this data source to access information about an existing Redis Cache

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/redis_cache.html.markdown.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL