dax

package
v1.31.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster

type Cluster struct {
	pulumi.CustomResourceState

	// The ARN of the DAX cluster
	Arn pulumi.StringOutput `pulumi:"arn"`
	// List of Availability Zones in which the
	// nodes will be created
	AvailabilityZones pulumi.StringArrayOutput `pulumi:"availabilityZones"`
	// The DNS name of the DAX cluster without the port appended
	ClusterAddress pulumi.StringOutput `pulumi:"clusterAddress"`
	// Group identifier. DAX converts this name to
	// lowercase
	ClusterName pulumi.StringOutput `pulumi:"clusterName"`
	// The configuration endpoint for this DAX cluster,
	// consisting of a DNS name and a port number
	ConfigurationEndpoint pulumi.StringOutput `pulumi:"configurationEndpoint"`
	// Description for the cluster
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A valid Amazon Resource Name (ARN) that identifies
	// an IAM role. At runtime, DAX will assume this role and use the role's
	// permissions to access DynamoDB on your behalf
	IamRoleArn pulumi.StringOutput `pulumi:"iamRoleArn"`
	// Specifies the weekly time range for when
	// maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi`
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:
	// `sun:05:00-sun:09:00`
	MaintenanceWindow pulumi.StringOutput `pulumi:"maintenanceWindow"`
	// The compute and memory capacity of the nodes. See
	// [Nodes][1] for supported node types
	NodeType pulumi.StringOutput `pulumi:"nodeType"`
	// List of node objects including `id`, `address`, `port` and
	// `availabilityZone`. Referenceable e.g. as
	// `${aws_dax_cluster.test.nodes.0.address}`
	Nodes ClusterNodeArrayOutput `pulumi:"nodes"`
	// An Amazon Resource Name (ARN) of an
	// SNS topic to send DAX notifications to. Example:
	// `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
	NotificationTopicArn pulumi.StringPtrOutput `pulumi:"notificationTopicArn"`
	// Name of the parameter group to associate
	// with this DAX cluster
	ParameterGroupName pulumi.StringOutput `pulumi:"parameterGroupName"`
	// The port used by the configuration endpoint
	Port pulumi.IntOutput `pulumi:"port"`
	// The number of nodes in the DAX cluster. A
	// replication factor of 1 will create a single-node cluster, without any read
	// replicas
	ReplicationFactor pulumi.IntOutput `pulumi:"replicationFactor"`
	// One or more VPC security groups associated
	// with the cluster
	SecurityGroupIds pulumi.StringArrayOutput `pulumi:"securityGroupIds"`
	// Encrypt at rest options
	ServerSideEncryption ClusterServerSideEncryptionPtrOutput `pulumi:"serverSideEncryption"`
	// Name of the subnet group to be used for the
	// cluster
	SubnetGroupName pulumi.StringOutput `pulumi:"subnetGroupName"`
	// A mapping of tags to assign to the resource
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides a DAX Cluster resource.

func GetCluster

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClusterState, opts ...pulumi.ResourceOption) (*Cluster, error)

GetCluster gets an existing Cluster 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 NewCluster

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOption) (*Cluster, error)

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

type ClusterArgs

type ClusterArgs struct {
	// List of Availability Zones in which the
	// nodes will be created
	AvailabilityZones pulumi.StringArrayInput
	// Group identifier. DAX converts this name to
	// lowercase
	ClusterName pulumi.StringInput
	// Description for the cluster
	Description pulumi.StringPtrInput
	// A valid Amazon Resource Name (ARN) that identifies
	// an IAM role. At runtime, DAX will assume this role and use the role's
	// permissions to access DynamoDB on your behalf
	IamRoleArn pulumi.StringInput
	// Specifies the weekly time range for when
	// maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi`
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:
	// `sun:05:00-sun:09:00`
	MaintenanceWindow pulumi.StringPtrInput
	// The compute and memory capacity of the nodes. See
	// [Nodes][1] for supported node types
	NodeType pulumi.StringInput
	// An Amazon Resource Name (ARN) of an
	// SNS topic to send DAX notifications to. Example:
	// `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
	NotificationTopicArn pulumi.StringPtrInput
	// Name of the parameter group to associate
	// with this DAX cluster
	ParameterGroupName pulumi.StringPtrInput
	// The number of nodes in the DAX cluster. A
	// replication factor of 1 will create a single-node cluster, without any read
	// replicas
	ReplicationFactor pulumi.IntInput
	// One or more VPC security groups associated
	// with the cluster
	SecurityGroupIds pulumi.StringArrayInput
	// Encrypt at rest options
	ServerSideEncryption ClusterServerSideEncryptionPtrInput
	// Name of the subnet group to be used for the
	// cluster
	SubnetGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource
	Tags pulumi.MapInput
}

The set of arguments for constructing a Cluster resource.

func (ClusterArgs) ElementType

func (ClusterArgs) ElementType() reflect.Type

type ClusterNode

type ClusterNode struct {
	Address          *string `pulumi:"address"`
	AvailabilityZone *string `pulumi:"availabilityZone"`
	Id               *string `pulumi:"id"`
	// The port used by the configuration endpoint
	Port *int `pulumi:"port"`
}

type ClusterNodeArgs

type ClusterNodeArgs struct {
	Address          pulumi.StringPtrInput `pulumi:"address"`
	AvailabilityZone pulumi.StringPtrInput `pulumi:"availabilityZone"`
	Id               pulumi.StringPtrInput `pulumi:"id"`
	// The port used by the configuration endpoint
	Port pulumi.IntPtrInput `pulumi:"port"`
}

func (ClusterNodeArgs) ElementType

func (ClusterNodeArgs) ElementType() reflect.Type

func (ClusterNodeArgs) ToClusterNodeOutput

func (i ClusterNodeArgs) ToClusterNodeOutput() ClusterNodeOutput

func (ClusterNodeArgs) ToClusterNodeOutputWithContext

func (i ClusterNodeArgs) ToClusterNodeOutputWithContext(ctx context.Context) ClusterNodeOutput

type ClusterNodeArray

type ClusterNodeArray []ClusterNodeInput

func (ClusterNodeArray) ElementType

func (ClusterNodeArray) ElementType() reflect.Type

func (ClusterNodeArray) ToClusterNodeArrayOutput

func (i ClusterNodeArray) ToClusterNodeArrayOutput() ClusterNodeArrayOutput

func (ClusterNodeArray) ToClusterNodeArrayOutputWithContext

func (i ClusterNodeArray) ToClusterNodeArrayOutputWithContext(ctx context.Context) ClusterNodeArrayOutput

type ClusterNodeArrayInput

type ClusterNodeArrayInput interface {
	pulumi.Input

	ToClusterNodeArrayOutput() ClusterNodeArrayOutput
	ToClusterNodeArrayOutputWithContext(context.Context) ClusterNodeArrayOutput
}

type ClusterNodeArrayOutput

type ClusterNodeArrayOutput struct{ *pulumi.OutputState }

func (ClusterNodeArrayOutput) ElementType

func (ClusterNodeArrayOutput) ElementType() reflect.Type

func (ClusterNodeArrayOutput) Index

func (ClusterNodeArrayOutput) ToClusterNodeArrayOutput

func (o ClusterNodeArrayOutput) ToClusterNodeArrayOutput() ClusterNodeArrayOutput

func (ClusterNodeArrayOutput) ToClusterNodeArrayOutputWithContext

func (o ClusterNodeArrayOutput) ToClusterNodeArrayOutputWithContext(ctx context.Context) ClusterNodeArrayOutput

type ClusterNodeInput

type ClusterNodeInput interface {
	pulumi.Input

	ToClusterNodeOutput() ClusterNodeOutput
	ToClusterNodeOutputWithContext(context.Context) ClusterNodeOutput
}

type ClusterNodeOutput

type ClusterNodeOutput struct{ *pulumi.OutputState }

func (ClusterNodeOutput) Address

func (ClusterNodeOutput) AvailabilityZone

func (o ClusterNodeOutput) AvailabilityZone() pulumi.StringPtrOutput

func (ClusterNodeOutput) ElementType

func (ClusterNodeOutput) ElementType() reflect.Type

func (ClusterNodeOutput) Id

func (ClusterNodeOutput) Port

The port used by the configuration endpoint

func (ClusterNodeOutput) ToClusterNodeOutput

func (o ClusterNodeOutput) ToClusterNodeOutput() ClusterNodeOutput

func (ClusterNodeOutput) ToClusterNodeOutputWithContext

func (o ClusterNodeOutput) ToClusterNodeOutputWithContext(ctx context.Context) ClusterNodeOutput

type ClusterServerSideEncryption

type ClusterServerSideEncryption struct {
	// Whether to enable encryption at rest. Defaults to `false`.
	Enabled *bool `pulumi:"enabled"`
}

type ClusterServerSideEncryptionArgs

type ClusterServerSideEncryptionArgs struct {
	// Whether to enable encryption at rest. Defaults to `false`.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
}

func (ClusterServerSideEncryptionArgs) ElementType

func (ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionOutput

func (i ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionOutput() ClusterServerSideEncryptionOutput

func (ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionOutputWithContext

func (i ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionOutputWithContext(ctx context.Context) ClusterServerSideEncryptionOutput

func (ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionPtrOutput

func (i ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionPtrOutput() ClusterServerSideEncryptionPtrOutput

func (ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionPtrOutputWithContext

func (i ClusterServerSideEncryptionArgs) ToClusterServerSideEncryptionPtrOutputWithContext(ctx context.Context) ClusterServerSideEncryptionPtrOutput

type ClusterServerSideEncryptionInput

type ClusterServerSideEncryptionInput interface {
	pulumi.Input

	ToClusterServerSideEncryptionOutput() ClusterServerSideEncryptionOutput
	ToClusterServerSideEncryptionOutputWithContext(context.Context) ClusterServerSideEncryptionOutput
}

type ClusterServerSideEncryptionOutput

type ClusterServerSideEncryptionOutput struct{ *pulumi.OutputState }

func (ClusterServerSideEncryptionOutput) ElementType

func (ClusterServerSideEncryptionOutput) Enabled

Whether to enable encryption at rest. Defaults to `false`.

func (ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionOutput

func (o ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionOutput() ClusterServerSideEncryptionOutput

func (ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionOutputWithContext

func (o ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionOutputWithContext(ctx context.Context) ClusterServerSideEncryptionOutput

func (ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionPtrOutput

func (o ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionPtrOutput() ClusterServerSideEncryptionPtrOutput

func (ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionPtrOutputWithContext

func (o ClusterServerSideEncryptionOutput) ToClusterServerSideEncryptionPtrOutputWithContext(ctx context.Context) ClusterServerSideEncryptionPtrOutput

type ClusterServerSideEncryptionPtrInput

type ClusterServerSideEncryptionPtrInput interface {
	pulumi.Input

	ToClusterServerSideEncryptionPtrOutput() ClusterServerSideEncryptionPtrOutput
	ToClusterServerSideEncryptionPtrOutputWithContext(context.Context) ClusterServerSideEncryptionPtrOutput
}

type ClusterServerSideEncryptionPtrOutput

type ClusterServerSideEncryptionPtrOutput struct{ *pulumi.OutputState }

func (ClusterServerSideEncryptionPtrOutput) Elem

func (ClusterServerSideEncryptionPtrOutput) ElementType

func (ClusterServerSideEncryptionPtrOutput) Enabled

Whether to enable encryption at rest. Defaults to `false`.

func (ClusterServerSideEncryptionPtrOutput) ToClusterServerSideEncryptionPtrOutput

func (o ClusterServerSideEncryptionPtrOutput) ToClusterServerSideEncryptionPtrOutput() ClusterServerSideEncryptionPtrOutput

func (ClusterServerSideEncryptionPtrOutput) ToClusterServerSideEncryptionPtrOutputWithContext

func (o ClusterServerSideEncryptionPtrOutput) ToClusterServerSideEncryptionPtrOutputWithContext(ctx context.Context) ClusterServerSideEncryptionPtrOutput

type ClusterState

type ClusterState struct {
	// The ARN of the DAX cluster
	Arn pulumi.StringPtrInput
	// List of Availability Zones in which the
	// nodes will be created
	AvailabilityZones pulumi.StringArrayInput
	// The DNS name of the DAX cluster without the port appended
	ClusterAddress pulumi.StringPtrInput
	// Group identifier. DAX converts this name to
	// lowercase
	ClusterName pulumi.StringPtrInput
	// The configuration endpoint for this DAX cluster,
	// consisting of a DNS name and a port number
	ConfigurationEndpoint pulumi.StringPtrInput
	// Description for the cluster
	Description pulumi.StringPtrInput
	// A valid Amazon Resource Name (ARN) that identifies
	// an IAM role. At runtime, DAX will assume this role and use the role's
	// permissions to access DynamoDB on your behalf
	IamRoleArn pulumi.StringPtrInput
	// Specifies the weekly time range for when
	// maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi`
	// (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:
	// `sun:05:00-sun:09:00`
	MaintenanceWindow pulumi.StringPtrInput
	// The compute and memory capacity of the nodes. See
	// [Nodes][1] for supported node types
	NodeType pulumi.StringPtrInput
	// List of node objects including `id`, `address`, `port` and
	// `availabilityZone`. Referenceable e.g. as
	// `${aws_dax_cluster.test.nodes.0.address}`
	Nodes ClusterNodeArrayInput
	// An Amazon Resource Name (ARN) of an
	// SNS topic to send DAX notifications to. Example:
	// `arn:aws:sns:us-east-1:012345678999:my_sns_topic`
	NotificationTopicArn pulumi.StringPtrInput
	// Name of the parameter group to associate
	// with this DAX cluster
	ParameterGroupName pulumi.StringPtrInput
	// The port used by the configuration endpoint
	Port pulumi.IntPtrInput
	// The number of nodes in the DAX cluster. A
	// replication factor of 1 will create a single-node cluster, without any read
	// replicas
	ReplicationFactor pulumi.IntPtrInput
	// One or more VPC security groups associated
	// with the cluster
	SecurityGroupIds pulumi.StringArrayInput
	// Encrypt at rest options
	ServerSideEncryption ClusterServerSideEncryptionPtrInput
	// Name of the subnet group to be used for the
	// cluster
	SubnetGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource
	Tags pulumi.MapInput
}

func (ClusterState) ElementType

func (ClusterState) ElementType() reflect.Type

type ParameterGroup

type ParameterGroup struct {
	pulumi.CustomResourceState

	// A description of the parameter group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the parameter group.
	Name pulumi.StringOutput `pulumi:"name"`
	// The parameters of the parameter group.
	Parameters ParameterGroupParameterArrayOutput `pulumi:"parameters"`
}

Provides a DAX Parameter Group resource.

## parameters

`parameters` supports the following:

* `name` - (Required) The name of the parameter. * `value` - (Required) The value for the parameter.

func GetParameterGroup

func GetParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ParameterGroupState, opts ...pulumi.ResourceOption) (*ParameterGroup, error)

GetParameterGroup gets an existing ParameterGroup 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 NewParameterGroup

func NewParameterGroup(ctx *pulumi.Context,
	name string, args *ParameterGroupArgs, opts ...pulumi.ResourceOption) (*ParameterGroup, error)

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

type ParameterGroupArgs

type ParameterGroupArgs struct {
	// A description of the parameter group.
	Description pulumi.StringPtrInput
	// The name of the parameter group.
	Name pulumi.StringPtrInput
	// The parameters of the parameter group.
	Parameters ParameterGroupParameterArrayInput
}

The set of arguments for constructing a ParameterGroup resource.

func (ParameterGroupArgs) ElementType

func (ParameterGroupArgs) ElementType() reflect.Type

type ParameterGroupParameter

type ParameterGroupParameter struct {
	// The name of the parameter group.
	Name  string `pulumi:"name"`
	Value string `pulumi:"value"`
}

type ParameterGroupParameterArgs

type ParameterGroupParameterArgs struct {
	// The name of the parameter group.
	Name  pulumi.StringInput `pulumi:"name"`
	Value pulumi.StringInput `pulumi:"value"`
}

func (ParameterGroupParameterArgs) ElementType

func (ParameterGroupParameterArgs) ToParameterGroupParameterOutput

func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutput() ParameterGroupParameterOutput

func (ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext

func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput

type ParameterGroupParameterArray

type ParameterGroupParameterArray []ParameterGroupParameterInput

func (ParameterGroupParameterArray) ElementType

func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput

func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput

func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext

func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput

type ParameterGroupParameterArrayInput

type ParameterGroupParameterArrayInput interface {
	pulumi.Input

	ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
	ToParameterGroupParameterArrayOutputWithContext(context.Context) ParameterGroupParameterArrayOutput
}

type ParameterGroupParameterArrayOutput

type ParameterGroupParameterArrayOutput struct{ *pulumi.OutputState }

func (ParameterGroupParameterArrayOutput) ElementType

func (ParameterGroupParameterArrayOutput) Index

func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput

func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput

func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext

func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput

type ParameterGroupParameterInput

type ParameterGroupParameterInput interface {
	pulumi.Input

	ToParameterGroupParameterOutput() ParameterGroupParameterOutput
	ToParameterGroupParameterOutputWithContext(context.Context) ParameterGroupParameterOutput
}

type ParameterGroupParameterOutput

type ParameterGroupParameterOutput struct{ *pulumi.OutputState }

func (ParameterGroupParameterOutput) ElementType

func (ParameterGroupParameterOutput) Name

The name of the parameter group.

func (ParameterGroupParameterOutput) ToParameterGroupParameterOutput

func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput

func (ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext

func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput

func (ParameterGroupParameterOutput) Value

type ParameterGroupState

type ParameterGroupState struct {
	// A description of the parameter group.
	Description pulumi.StringPtrInput
	// The name of the parameter group.
	Name pulumi.StringPtrInput
	// The parameters of the parameter group.
	Parameters ParameterGroupParameterArrayInput
}

func (ParameterGroupState) ElementType

func (ParameterGroupState) ElementType() reflect.Type

type SubnetGroup

type SubnetGroup struct {
	pulumi.CustomResourceState

	// A description of the subnet group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the subnet group.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of VPC subnet IDs for the subnet group.
	SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"`
	// VPC ID of the subnet group.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
}

Provides a DAX Subnet Group resource.

func GetSubnetGroup

func GetSubnetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SubnetGroupState, opts ...pulumi.ResourceOption) (*SubnetGroup, error)

GetSubnetGroup gets an existing SubnetGroup 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 NewSubnetGroup

func NewSubnetGroup(ctx *pulumi.Context,
	name string, args *SubnetGroupArgs, opts ...pulumi.ResourceOption) (*SubnetGroup, error)

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

type SubnetGroupArgs

type SubnetGroupArgs struct {
	// A description of the subnet group.
	Description pulumi.StringPtrInput
	// The name of the subnet group.
	Name pulumi.StringPtrInput
	// A list of VPC subnet IDs for the subnet group.
	SubnetIds pulumi.StringArrayInput
}

The set of arguments for constructing a SubnetGroup resource.

func (SubnetGroupArgs) ElementType

func (SubnetGroupArgs) ElementType() reflect.Type

type SubnetGroupState

type SubnetGroupState struct {
	// A description of the subnet group.
	Description pulumi.StringPtrInput
	// The name of the subnet group.
	Name pulumi.StringPtrInput
	// A list of VPC subnet IDs for the subnet group.
	SubnetIds pulumi.StringArrayInput
	// VPC ID of the subnet group.
	VpcId pulumi.StringPtrInput
}

func (SubnetGroupState) ElementType

func (SubnetGroupState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

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