redis

package
v1.3.1 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package redis exports types, functions, subpackages for provisioning redis resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-azurerm) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-azure` repo](https://github.com/pulumi/pulumi-azure/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-azurerm` repo](https://github.com/terraform-providers/terraform-provider-azurerm/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cache 

type Cache struct {
	// contains filtered or unexported fields
}

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.ID, state *CacheState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*Cache, error)

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

func (*Cache) Capacity 

func (r *Cache) Capacity() *pulumi.IntOutput

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`.

func (*Cache) EnableNonSslPort 

func (r *Cache) EnableNonSslPort() *pulumi.BoolOutput

Enable the non-SSL port (6379) - disabled by default.

func (*Cache) Family 

func (r *Cache) Family() *pulumi.StringOutput

The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)

func (*Cache) Hostname 

func (r *Cache) Hostname() *pulumi.StringOutput

The Hostname of the Redis Instance

func (*Cache) ID 

func (r *Cache) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cache) Location 

func (r *Cache) Location() *pulumi.StringOutput

The location of the resource group.

func (*Cache) MinimumTlsVersion added in v0.18.0 

func (r *Cache) MinimumTlsVersion() *pulumi.StringOutput

The minimum TLS version. Defaults to `1.0`.

func (*Cache) Name 

func (r *Cache) Name() *pulumi.StringOutput

The name of the Redis instance. Changing this forces a new resource to be created.

func (*Cache) PatchSchedules 

func (r *Cache) PatchSchedules() *pulumi.ArrayOutput

A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.

func (*Cache) Port 

func (r *Cache) Port() *pulumi.IntOutput

The non-SSL Port of the Redis Instance

func (*Cache) PrimaryAccessKey 

func (r *Cache) PrimaryAccessKey() *pulumi.StringOutput

The Primary Access Key for the Redis Instance

func (*Cache) PrivateStaticIpAddress 

func (r *Cache) PrivateStaticIpAddress() *pulumi.StringOutput

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.

func (*Cache) RedisConfiguration 

func (r *Cache) RedisConfiguration() *pulumi.Output

A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.

func (*Cache) ResourceGroupName 

func (r *Cache) ResourceGroupName() *pulumi.StringOutput

The name of the resource group in which to create the Redis instance.

func (*Cache) SecondaryAccessKey 

func (r *Cache) SecondaryAccessKey() *pulumi.StringOutput

The Secondary Access Key for the Redis Instance

func (*Cache) ShardCount 

func (r *Cache) ShardCount() *pulumi.IntOutput

*Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.

func (*Cache) SkuName 

func (r *Cache) SkuName() *pulumi.StringOutput

The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.

func (*Cache) SslPort 

func (r *Cache) SslPort() *pulumi.IntOutput

The SSL Port of the Redis Instance

func (*Cache) SubnetId 

func (r *Cache) SubnetId() *pulumi.StringOutput

*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.

func (*Cache) Tags 

func (r *Cache) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Cache) URN 

func (r *Cache) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Cache) Zones added in v0.16.7 

func (r *Cache) Zones() *pulumi.StringOutput

A list of a single item of the Availability Zone which the Redis Cache should be allocated in.

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 interface{}
	// Enable the non-SSL port (6379) - disabled by default.
	EnableNonSslPort interface{}
	// The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family interface{}
	// The location of the resource group.
	Location interface{}
	// The minimum TLS version.  Defaults to `1.0`.
	MinimumTlsVersion interface{}
	// The name of the Redis instance. Changing this forces a
	// new resource to be created.
	Name interface{}
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules interface{}
	// 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 interface{}
	// A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.
	RedisConfiguration interface{}
	// The name of the resource group in which to
	// create the Redis instance.
	ResourceGroupName interface{}
	// *Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.
	ShardCount interface{}
	// The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName interface{}
	// *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 interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// A list of a single item of the Availability Zone which the Redis Cache should be allocated in.
	Zones interface{}
}

The set of arguments for constructing a Cache resource.

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 interface{}
	// Enable the non-SSL port (6379) - disabled by default.
	EnableNonSslPort interface{}
	// The SKU family/pricing group to use. Valid values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family interface{}
	// The Hostname of the Redis Instance
	Hostname interface{}
	// The location of the resource group.
	Location interface{}
	// The minimum TLS version.  Defaults to `1.0`.
	MinimumTlsVersion interface{}
	// The name of the Redis instance. Changing this forces a
	// new resource to be created.
	Name interface{}
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules interface{}
	// The non-SSL Port of the Redis Instance
	Port interface{}
	// The Primary Access Key for the Redis Instance
	PrimaryAccessKey interface{}
	// 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 interface{}
	// A `redisConfiguration` as defined below - with some limitations by SKU - defaults/details are shown below.
	RedisConfiguration interface{}
	// The name of the resource group in which to
	// create the Redis instance.
	ResourceGroupName interface{}
	// The Secondary Access Key for the Redis Instance
	SecondaryAccessKey interface{}
	// *Only available when using the Premium SKU* The number of Shards to create on the Redis Cluster.
	ShardCount interface{}
	// The SKU of Redis to use. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName interface{}
	// The SSL Port of the Redis Instance
	SslPort interface{}
	// *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 interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// A list of a single item of the Availability Zone which the Redis Cache should be allocated in.
	Zones interface{}
}

Input properties used for looking up and filtering Cache resources.

type FirewallRule 

type FirewallRule struct {
	// contains filtered or unexported fields
}

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.ID, state *FirewallRuleState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*FirewallRule, error)

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

func (*FirewallRule) EndIp 

func (r *FirewallRule) EndIp() *pulumi.StringOutput

The highest IP address included in the range.

func (*FirewallRule) ID 

func (r *FirewallRule) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*FirewallRule) Name 

func (r *FirewallRule) Name() *pulumi.StringOutput

The name of the Firewall Rule. Changing this forces a new resource to be created.

func (*FirewallRule) RedisCacheName 

func (r *FirewallRule) RedisCacheName() *pulumi.StringOutput

The name of the Redis Cache. Changing this forces a new resource to be created.

func (*FirewallRule) ResourceGroupName 

func (r *FirewallRule) ResourceGroupName() *pulumi.StringOutput

The name of the resource group in which this Redis Cache exists.

func (*FirewallRule) StartIp 

func (r *FirewallRule) StartIp() *pulumi.StringOutput

The lowest IP address included in the range

func (*FirewallRule) URN 

func (r *FirewallRule) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type FirewallRuleArgs 

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

The set of arguments for constructing a FirewallRule resource.

type FirewallRuleState 

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

Input properties used for looking up and filtering FirewallRule resources.

type GetCacheArgs added in v0.18.6 

type GetCacheArgs struct {
	// The name of the Redis cache
	Name interface{}
	// The name of the resource group the Redis cache instance is located in.
	ResourceGroupName interface{}
	Zones             interface{}
}

A collection of arguments for invoking getCache.

type GetCacheResult added in v0.18.6 

type GetCacheResult struct {
	// The size of the Redis Cache deployed.
	Capacity interface{}
	// Whether the SSL port is enabled.
	EnableNonSslPort interface{}
	// The SKU family/pricing group used. Possible values are `C` (for Basic/Standard SKU family) and `P` (for `Premium`)
	Family interface{}
	// The Hostname of the Redis Instance
	Hostname interface{}
	// The location of the Redis Cache.
	Location interface{}
	// The minimum TLS version.
	MinimumTlsVersion interface{}
	Name              interface{}
	// A list of `patchSchedule` blocks as defined below - only available for Premium SKU's.
	PatchSchedules interface{}
	// The non-SSL Port of the Redis Instance
	Port interface{}
	// The Primary Access Key for the Redis Instance
	PrimaryAccessKey       interface{}
	PrivateStaticIpAddress interface{}
	// A `redisConfiguration` block as defined below.
	RedisConfigurations interface{}
	ResourceGroupName   interface{}
	// The Secondary Access Key for the Redis Instance
	SecondaryAccessKey interface{}
	ShardCount         interface{}
	// The SKU of Redis used. Possible values are `Basic`, `Standard` and `Premium`.
	SkuName interface{}
	// The SSL Port of the Redis Instance
	SslPort  interface{}
	SubnetId interface{}
	Tags     interface{}
	Zones    interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getCache.

func LookupCache added in v0.18.6 

func LookupCache(ctx *pulumi.Context, args *GetCacheArgs) (*GetCacheResult, 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.