neptune

package
v0.16.1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster added in v0.15.1 

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

Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances.

Changes to a Neptune Cluster can occur when you manually change a parameter, such as `backup_retention_period`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `apply_immediately` flag to instruct the service to apply the change immediately (see documentation below).

func GetCluster added in v0.15.1 

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterState, opts ...pulumi.ResourceOpt) (*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 added in v0.15.1 

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

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

func (*Cluster) ApplyImmediately added in v0.15.1 

func (r *Cluster) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.

func (*Cluster) Arn added in v0.15.1 

func (r *Cluster) Arn() *pulumi.StringOutput

The Neptune Cluster Amazon Resource Name (ARN)

func (*Cluster) AvailabilityZones added in v0.15.1 

func (r *Cluster) AvailabilityZones() *pulumi.ArrayOutput

A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.

func (*Cluster) BackupRetentionPeriod added in v0.15.1 

func (r *Cluster) BackupRetentionPeriod() *pulumi.IntOutput

The days to retain backups for. Default `1`

func (*Cluster) ClusterIdentifier added in v0.15.1 

func (r *Cluster) ClusterIdentifier() *pulumi.StringOutput

The cluster identifier. If omitted, Terraform will assign a random, unique identifier.

func (*Cluster) ClusterIdentifierPrefix added in v0.15.1 

func (r *Cluster) ClusterIdentifierPrefix() *pulumi.StringOutput

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.

func (*Cluster) ClusterMembers added in v0.15.1 

func (r *Cluster) ClusterMembers() *pulumi.ArrayOutput

List of Neptune Instances that are a part of this cluster

func (*Cluster) ClusterResourceId added in v0.15.1 

func (r *Cluster) ClusterResourceId() *pulumi.StringOutput

The Neptune Cluster Resource ID

func (*Cluster) Endpoint added in v0.15.1 

func (r *Cluster) Endpoint() *pulumi.StringOutput

The DNS address of the Neptune instance

func (*Cluster) Engine added in v0.15.1 

func (r *Cluster) Engine() *pulumi.StringOutput

The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`.

func (*Cluster) EngineVersion added in v0.15.1 

func (r *Cluster) EngineVersion() *pulumi.StringOutput

The database engine version.

func (*Cluster) FinalSnapshotIdentifier added in v0.15.1 

func (r *Cluster) FinalSnapshotIdentifier() *pulumi.StringOutput

The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

func (*Cluster) HostedZoneId added in v0.15.1 

func (r *Cluster) HostedZoneId() *pulumi.StringOutput

The Route53 Hosted Zone ID of the endpoint

func (*Cluster) ID added in v0.15.1 

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

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

func (*Cluster) IamDatabaseAuthenticationEnabled added in v0.15.1 

func (r *Cluster) IamDatabaseAuthenticationEnabled() *pulumi.BoolOutput

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

func (*Cluster) IamRoles added in v0.15.1 

func (r *Cluster) IamRoles() *pulumi.ArrayOutput

A List of ARNs for the IAM roles to associate to the Neptune Cluster.

func (*Cluster) KmsKeyArn added in v0.15.1 

func (r *Cluster) KmsKeyArn() *pulumi.StringOutput

The ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to true.

func (*Cluster) NeptuneClusterParameterGroupName added in v0.15.1 

func (r *Cluster) NeptuneClusterParameterGroupName() *pulumi.StringOutput

A cluster parameter group to associate with the cluster.

func (*Cluster) NeptuneSubnetGroupName added in v0.15.1 

func (r *Cluster) NeptuneSubnetGroupName() *pulumi.StringOutput

A Neptune subnet group to associate with this Neptune instance.

func (*Cluster) Port added in v0.15.1 

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

The port on which the Neptune accepts connections. Default is `8182`.

func (*Cluster) PreferredBackupWindow added in v0.15.1 

func (r *Cluster) PreferredBackupWindow() *pulumi.StringOutput

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

func (*Cluster) PreferredMaintenanceWindow added in v0.15.1 

func (r *Cluster) PreferredMaintenanceWindow() *pulumi.StringOutput

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

func (*Cluster) ReaderEndpoint added in v0.15.1 

func (r *Cluster) ReaderEndpoint() *pulumi.StringOutput

A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas

func (*Cluster) ReplicationSourceIdentifier added in v0.15.1 

func (r *Cluster) ReplicationSourceIdentifier() *pulumi.StringOutput

ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

func (*Cluster) SkipFinalSnapshot added in v0.15.1 

func (r *Cluster) SkipFinalSnapshot() *pulumi.BoolOutput

Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.

func (*Cluster) SnapshotIdentifier added in v0.15.1 

func (r *Cluster) SnapshotIdentifier() *pulumi.StringOutput

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.

func (*Cluster) StorageEncrypted added in v0.15.1 

func (r *Cluster) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified.

func (*Cluster) Tags added in v0.15.1 

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

A mapping of tags to assign to the Neptune cluster.

func (*Cluster) URN added in v0.15.1 

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

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

func (*Cluster) VpcSecurityGroupIds added in v0.15.1 

func (r *Cluster) VpcSecurityGroupIds() *pulumi.ArrayOutput

List of VPC security groups to associate with the Cluster

type ClusterArgs added in v0.15.1 

type ClusterArgs struct {
	// Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.
	ApplyImmediately interface{}
	// A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
	AvailabilityZones interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.
	ClusterIdentifierPrefix interface{}
	// The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`.
	Engine interface{}
	// The database engine version.
	EngineVersion interface{}
	// The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
	FinalSnapshotIdentifier interface{}
	// Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
	IamDatabaseAuthenticationEnabled interface{}
	// A List of ARNs for the IAM roles to associate to the Neptune Cluster.
	IamRoles interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to true.
	KmsKeyArn interface{}
	// A cluster parameter group to associate with the cluster.
	NeptuneClusterParameterGroupName interface{}
	// A Neptune subnet group to associate with this Neptune instance.
	NeptuneSubnetGroupName interface{}
	// The port on which the Neptune accepts connections. Default is `8182`.
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00
	PreferredBackupWindow interface{}
	// The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
	PreferredMaintenanceWindow interface{}
	// ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
	ReplicationSourceIdentifier interface{}
	// Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
	SkipFinalSnapshot interface{}
	// Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.
	SnapshotIdentifier interface{}
	// Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the Neptune cluster.
	Tags interface{}
	// List of VPC security groups to associate with the Cluster
	VpcSecurityGroupIds interface{}
}

The set of arguments for constructing a Cluster resource.

type ClusterInstance added in v0.15.1 

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

A Cluster Instance Resource defines attributes that are specific to a single instance in a Neptune Cluster.

You can simply add neptune instances and Neptune manages the replication. You can use the [count][1] meta-parameter to make multiple instances and join them all to the same Neptune Cluster, or you may specify different Cluster Instance resources with various `instance_class` sizes.

func GetClusterInstance added in v0.15.1 

func GetClusterInstance(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterInstanceState, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

GetClusterInstance gets an existing ClusterInstance 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 NewClusterInstance added in v0.15.1 

func NewClusterInstance(ctx *pulumi.Context,
	name string, args *ClusterInstanceArgs, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

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

func (*ClusterInstance) Address added in v0.15.1 

func (r *ClusterInstance) Address() *pulumi.StringOutput

The hostname of the instance. See also `endpoint` and `port`.

func (*ClusterInstance) ApplyImmediately added in v0.15.1 

func (r *ClusterInstance) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is`false`.

func (*ClusterInstance) Arn added in v0.15.1 

func (r *ClusterInstance) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of neptune instance

func (*ClusterInstance) AutoMinorVersionUpgrade added in v0.15.1 

func (r *ClusterInstance) AutoMinorVersionUpgrade() *pulumi.BoolOutput

Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`.

func (*ClusterInstance) AvailabilityZone added in v0.15.1 

func (r *ClusterInstance) AvailabilityZone() *pulumi.StringOutput

The EC2 Availability Zone that the neptune instance is created in.

func (*ClusterInstance) ClusterIdentifier added in v0.15.1 

func (r *ClusterInstance) ClusterIdentifier() *pulumi.StringOutput

The identifier of the [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html) in which to launch this instance.

func (*ClusterInstance) DbiResourceId added in v0.15.1 

func (r *ClusterInstance) DbiResourceId() *pulumi.StringOutput

The region-unique, immutable identifier for the neptune instance.

func (*ClusterInstance) Endpoint added in v0.15.1 

func (r *ClusterInstance) Endpoint() *pulumi.StringOutput

The connection endpoint in `address:port` format.

func (*ClusterInstance) Engine added in v0.15.1 

func (r *ClusterInstance) Engine() *pulumi.StringOutput

The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`.

func (*ClusterInstance) EngineVersion added in v0.15.1 

func (r *ClusterInstance) EngineVersion() *pulumi.StringOutput

The neptune engine version.

func (*ClusterInstance) ID added in v0.15.1 

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

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

func (*ClusterInstance) Identifier added in v0.15.1 

func (r *ClusterInstance) Identifier() *pulumi.StringOutput

The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.

func (*ClusterInstance) IdentifierPrefix added in v0.15.1 

func (r *ClusterInstance) IdentifierPrefix() *pulumi.StringOutput

Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.

func (*ClusterInstance) InstanceClass added in v0.15.1 

func (r *ClusterInstance) InstanceClass() *pulumi.StringOutput

The instance class to use.

func (*ClusterInstance) KmsKeyArn added in v0.15.1 

func (r *ClusterInstance) KmsKeyArn() *pulumi.StringOutput

The ARN for the KMS encryption key if one is set to the neptune cluster.

func (*ClusterInstance) NeptuneParameterGroupName added in v0.15.1 

func (r *ClusterInstance) NeptuneParameterGroupName() *pulumi.StringOutput

The name of the neptune parameter group to associate with this instance.

func (*ClusterInstance) NeptuneSubnetGroupName added in v0.15.1 

func (r *ClusterInstance) NeptuneSubnetGroupName() *pulumi.StringOutput

A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptune_subnet_group_name` of the attached [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html).

func (*ClusterInstance) Port added in v0.15.1 

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

The port on which the DB accepts connections. Defaults to `8182`.

func (*ClusterInstance) PreferredBackupWindow added in v0.15.1 

func (r *ClusterInstance) PreferredBackupWindow() *pulumi.StringOutput

The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"

func (*ClusterInstance) PreferredMaintenanceWindow added in v0.15.1 

func (r *ClusterInstance) PreferredMaintenanceWindow() *pulumi.StringOutput

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

func (*ClusterInstance) PromotionTier added in v0.15.1 

func (r *ClusterInstance) PromotionTier() *pulumi.IntOutput

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

func (*ClusterInstance) PubliclyAccessible added in v0.15.1 

func (r *ClusterInstance) PubliclyAccessible() *pulumi.BoolOutput

Bool to control if instance is publicly accessible. Default is `false`.

func (*ClusterInstance) StorageEncrypted added in v0.15.1 

func (r *ClusterInstance) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the neptune cluster is encrypted.

func (*ClusterInstance) Tags added in v0.15.1 

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

A mapping of tags to assign to the instance.

func (*ClusterInstance) URN added in v0.15.1 

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

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

func (*ClusterInstance) Writer added in v0.15.1 

func (r *ClusterInstance) Writer() *pulumi.BoolOutput

Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.

type ClusterInstanceArgs added in v0.15.1 

type ClusterInstanceArgs struct {
	// Specifies whether any instance modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the neptune instance is created in.
	AvailabilityZone interface{}
	// The identifier of the [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`.
	Engine interface{}
	// The neptune engine version.
	EngineVersion interface{}
	// The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.
	IdentifierPrefix interface{}
	// The instance class to use.
	InstanceClass interface{}
	// The name of the neptune parameter group to associate with this instance.
	NeptuneParameterGroupName interface{}
	// A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptune_subnet_group_name` of the attached [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html).
	NeptuneSubnetGroupName interface{}
	// The port on which the DB accepts connections. Defaults to `8182`.
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
	PreferredBackupWindow interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier interface{}
	// Bool to control if instance is publicly accessible. Default is `false`.
	PubliclyAccessible interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
}

The set of arguments for constructing a ClusterInstance resource.

type ClusterInstanceState added in v0.15.1 

type ClusterInstanceState struct {
	// The hostname of the instance. See also `endpoint` and `port`.
	Address interface{}
	// Specifies whether any instance modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Amazon Resource Name (ARN) of neptune instance
	Arn interface{}
	// Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the neptune instance is created in.
	AvailabilityZone interface{}
	// The identifier of the [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// The region-unique, immutable identifier for the neptune instance.
	DbiResourceId interface{}
	// The connection endpoint in `address:port` format.
	Endpoint interface{}
	// The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`.
	Engine interface{}
	// The neptune engine version.
	EngineVersion interface{}
	// The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.
	IdentifierPrefix interface{}
	// The instance class to use.
	InstanceClass interface{}
	// The ARN for the KMS encryption key if one is set to the neptune cluster.
	KmsKeyArn interface{}
	// The name of the neptune parameter group to associate with this instance.
	NeptuneParameterGroupName interface{}
	// A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptune_subnet_group_name` of the attached [`aws_neptune_cluster`](https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html).
	NeptuneSubnetGroupName interface{}
	// The port on which the DB accepts connections. Defaults to `8182`.
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
	PreferredBackupWindow interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier interface{}
	// Bool to control if instance is publicly accessible. Default is `false`.
	PubliclyAccessible interface{}
	// Specifies whether the neptune cluster is encrypted.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
	// Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.
	Writer interface{}
}

Input properties used for looking up and filtering ClusterInstance resources.

type ClusterParameterGroup 

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

Manages a Neptune Cluster Parameter Group

func GetClusterParameterGroup 

func GetClusterParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterParameterGroupState, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

GetClusterParameterGroup gets an existing ClusterParameterGroup 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 NewClusterParameterGroup 

func NewClusterParameterGroup(ctx *pulumi.Context,
	name string, args *ClusterParameterGroupArgs, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

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

func (*ClusterParameterGroup) Arn 

func (r *ClusterParameterGroup) Arn() *pulumi.StringOutput

The ARN of the neptune cluster parameter group.

func (*ClusterParameterGroup) Description 

func (r *ClusterParameterGroup) Description() *pulumi.StringOutput

The description of the neptune cluster parameter group. Defaults to "Managed by Terraform".

func (*ClusterParameterGroup) Family 

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

The family of the neptune cluster parameter group.

func (*ClusterParameterGroup) ID 

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

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

func (*ClusterParameterGroup) Name 

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

The name of the neptune parameter.

func (*ClusterParameterGroup) NamePrefix 

func (r *ClusterParameterGroup) NamePrefix() *pulumi.StringOutput

Creates a unique name beginning with the specified prefix. Conflicts with `name`.

func (*ClusterParameterGroup) Parameters 

func (r *ClusterParameterGroup) Parameters() *pulumi.ArrayOutput

A list of neptune parameters to apply.

func (*ClusterParameterGroup) Tags 

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

A mapping of tags to assign to the resource.

func (*ClusterParameterGroup) URN 

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

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

type ClusterParameterGroupArgs 

type ClusterParameterGroupArgs struct {
	// The description of the neptune cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the neptune cluster parameter group.
	Family interface{}
	// The name of the neptune parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of neptune parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a ClusterParameterGroup resource.

type ClusterParameterGroupState 

type ClusterParameterGroupState struct {
	// The ARN of the neptune cluster parameter group.
	Arn interface{}
	// The description of the neptune cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the neptune cluster parameter group.
	Family interface{}
	// The name of the neptune parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of neptune parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering ClusterParameterGroup resources.

type ClusterSnapshot added in v0.15.1 

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

Manages a Neptune database cluster snapshot.

func GetClusterSnapshot added in v0.15.1 

func GetClusterSnapshot(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterSnapshotState, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

GetClusterSnapshot gets an existing ClusterSnapshot 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 NewClusterSnapshot added in v0.15.1 

func NewClusterSnapshot(ctx *pulumi.Context,
	name string, args *ClusterSnapshotArgs, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

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

func (*ClusterSnapshot) AllocatedStorage added in v0.15.1 

func (r *ClusterSnapshot) AllocatedStorage() *pulumi.IntOutput

Specifies the allocated storage size in gigabytes (GB).

func (*ClusterSnapshot) AvailabilityZones added in v0.15.1 

func (r *ClusterSnapshot) AvailabilityZones() *pulumi.ArrayOutput

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

func (*ClusterSnapshot) DbClusterIdentifier added in v0.15.1 

func (r *ClusterSnapshot) DbClusterIdentifier() *pulumi.StringOutput

The DB Cluster Identifier from which to take the snapshot.

func (*ClusterSnapshot) DbClusterSnapshotArn added in v0.15.1 

func (r *ClusterSnapshot) DbClusterSnapshotArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

func (*ClusterSnapshot) DbClusterSnapshotIdentifier added in v0.15.1 

func (r *ClusterSnapshot) DbClusterSnapshotIdentifier() *pulumi.StringOutput

The Identifier for the snapshot.

func (*ClusterSnapshot) Engine added in v0.15.1 

func (r *ClusterSnapshot) Engine() *pulumi.StringOutput

Specifies the name of the database engine.

func (*ClusterSnapshot) EngineVersion added in v0.15.1 

func (r *ClusterSnapshot) EngineVersion() *pulumi.StringOutput

Version of the database engine for this DB cluster snapshot.

func (*ClusterSnapshot) ID added in v0.15.1 

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

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

func (*ClusterSnapshot) KmsKeyId added in v0.15.1 

func (r *ClusterSnapshot) KmsKeyId() *pulumi.StringOutput

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

func (*ClusterSnapshot) LicenseModel added in v0.15.1 

func (r *ClusterSnapshot) LicenseModel() *pulumi.StringOutput

License model information for the restored DB cluster.

func (*ClusterSnapshot) Port added in v0.15.1 

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

Port that the DB cluster was listening on at the time of the snapshot.

func (*ClusterSnapshot) SnapshotType added in v0.15.1 

func (r *ClusterSnapshot) SnapshotType() *pulumi.StringOutput

func (*ClusterSnapshot) SourceDbClusterSnapshotArn added in v0.15.1 

func (r *ClusterSnapshot) SourceDbClusterSnapshotArn() *pulumi.StringOutput

func (*ClusterSnapshot) Status added in v0.15.1 

func (r *ClusterSnapshot) Status() *pulumi.StringOutput

The status of this DB Cluster Snapshot.

func (*ClusterSnapshot) StorageEncrypted added in v0.15.1 

func (r *ClusterSnapshot) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DB cluster snapshot is encrypted.

func (*ClusterSnapshot) URN added in v0.15.1 

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

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

func (*ClusterSnapshot) VpcId added in v0.15.1 

func (r *ClusterSnapshot) VpcId() *pulumi.StringOutput

The VPC ID associated with the DB cluster snapshot.

type ClusterSnapshotArgs added in v0.15.1 

type ClusterSnapshotArgs struct {
	// The DB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
}

The set of arguments for constructing a ClusterSnapshot resource.

type ClusterSnapshotState added in v0.15.1 

type ClusterSnapshotState struct {
	// Specifies the allocated storage size in gigabytes (GB).
	AllocatedStorage interface{}
	// List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
	AvailabilityZones interface{}
	// The DB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
	DbClusterSnapshotArn interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Version of the database engine for this DB cluster snapshot.
	EngineVersion interface{}
	// If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
	KmsKeyId interface{}
	// License model information for the restored DB cluster.
	LicenseModel interface{}
	// Port that the DB cluster was listening on at the time of the snapshot.
	Port                       interface{}
	SnapshotType               interface{}
	SourceDbClusterSnapshotArn interface{}
	// The status of this DB Cluster Snapshot.
	Status interface{}
	// Specifies whether the DB cluster snapshot is encrypted.
	StorageEncrypted interface{}
	// The VPC ID associated with the DB cluster snapshot.
	VpcId interface{}
}

Input properties used for looking up and filtering ClusterSnapshot resources.

type ClusterState added in v0.15.1 

type ClusterState struct {
	// Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.
	ApplyImmediately interface{}
	// The Neptune Cluster Amazon Resource Name (ARN)
	Arn interface{}
	// A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
	AvailabilityZones interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.
	ClusterIdentifierPrefix interface{}
	// List of Neptune Instances that are a part of this cluster
	ClusterMembers interface{}
	// The Neptune Cluster Resource ID
	ClusterResourceId interface{}
	// The DNS address of the Neptune instance
	Endpoint interface{}
	// The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`.
	Engine interface{}
	// The database engine version.
	EngineVersion interface{}
	// The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
	FinalSnapshotIdentifier interface{}
	// The Route53 Hosted Zone ID of the endpoint
	HostedZoneId interface{}
	// Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
	IamDatabaseAuthenticationEnabled interface{}
	// A List of ARNs for the IAM roles to associate to the Neptune Cluster.
	IamRoles interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to true.
	KmsKeyArn interface{}
	// A cluster parameter group to associate with the cluster.
	NeptuneClusterParameterGroupName interface{}
	// A Neptune subnet group to associate with this Neptune instance.
	NeptuneSubnetGroupName interface{}
	// The port on which the Neptune accepts connections. Default is `8182`.
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00
	PreferredBackupWindow interface{}
	// The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
	PreferredMaintenanceWindow interface{}
	// A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
	ReaderEndpoint interface{}
	// ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
	ReplicationSourceIdentifier interface{}
	// Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
	SkipFinalSnapshot interface{}
	// Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.
	SnapshotIdentifier interface{}
	// Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the Neptune cluster.
	Tags interface{}
	// List of VPC security groups to associate with the Cluster
	VpcSecurityGroupIds interface{}
}

Input properties used for looking up and filtering Cluster resources.

type EventSubscription added in v0.15.1 

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

func GetEventSubscription added in v0.15.1 

func GetEventSubscription(ctx *pulumi.Context,
	name string, id pulumi.ID, state *EventSubscriptionState, opts ...pulumi.ResourceOpt) (*EventSubscription, error)

GetEventSubscription gets an existing EventSubscription 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 NewEventSubscription added in v0.15.1 

func NewEventSubscription(ctx *pulumi.Context,
	name string, args *EventSubscriptionArgs, opts ...pulumi.ResourceOpt) (*EventSubscription, error)

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

func (*EventSubscription) Arn added in v0.15.1 

func (r *EventSubscription) Arn() *pulumi.StringOutput

func (*EventSubscription) CustomerAwsId added in v0.15.1 

func (r *EventSubscription) CustomerAwsId() *pulumi.StringOutput

func (*EventSubscription) Enabled added in v0.15.1 

func (r *EventSubscription) Enabled() *pulumi.BoolOutput

A boolean flag to enable/disable the subscription. Defaults to true.

func (*EventSubscription) EventCategories added in v0.15.1 

func (r *EventSubscription) EventCategories() *pulumi.ArrayOutput

A list of event categories for a `source_type` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories.

func (*EventSubscription) ID added in v0.15.1 

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

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

func (*EventSubscription) Name added in v0.15.1 

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

The name of the Neptune event subscription. By default generated by Terraform.

func (*EventSubscription) NamePrefix added in v0.15.1 

func (r *EventSubscription) NamePrefix() *pulumi.StringOutput

The name of the Neptune event subscription. Conflicts with `name`.

func (*EventSubscription) SnsTopicArn added in v0.15.1 

func (r *EventSubscription) SnsTopicArn() *pulumi.StringOutput

The ARN of the SNS topic to send events to.

func (*EventSubscription) SourceIds added in v0.15.1 

func (r *EventSubscription) SourceIds() *pulumi.ArrayOutput

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `source_type` must also be specified.

func (*EventSubscription) SourceType added in v0.15.1 

func (r *EventSubscription) SourceType() *pulumi.StringOutput

The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster` or `db-cluster-snapshot`. If not set, all sources will be subscribed to.

func (*EventSubscription) Tags added in v0.15.1 

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

A mapping of tags to assign to the resource.

func (*EventSubscription) URN added in v0.15.1 

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

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

type EventSubscriptionArgs added in v0.15.1 

type EventSubscriptionArgs struct {
	// A boolean flag to enable/disable the subscription. Defaults to true.
	Enabled interface{}
	// A list of event categories for a `source_type` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories.
	EventCategories interface{}
	// The name of the Neptune event subscription. By default generated by Terraform.
	Name interface{}
	// The name of the Neptune event subscription. Conflicts with `name`.
	NamePrefix interface{}
	// The ARN of the SNS topic to send events to.
	SnsTopicArn interface{}
	// A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `source_type` must also be specified.
	SourceIds interface{}
	// The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster` or `db-cluster-snapshot`. If not set, all sources will be subscribed to.
	SourceType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a EventSubscription resource.

type EventSubscriptionState added in v0.15.1 

type EventSubscriptionState struct {
	Arn           interface{}
	CustomerAwsId interface{}
	// A boolean flag to enable/disable the subscription. Defaults to true.
	Enabled interface{}
	// A list of event categories for a `source_type` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories.
	EventCategories interface{}
	// The name of the Neptune event subscription. By default generated by Terraform.
	Name interface{}
	// The name of the Neptune event subscription. Conflicts with `name`.
	NamePrefix interface{}
	// The ARN of the SNS topic to send events to.
	SnsTopicArn interface{}
	// A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `source_type` must also be specified.
	SourceIds interface{}
	// The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster` or `db-cluster-snapshot`. If not set, all sources will be subscribed to.
	SourceType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering EventSubscription resources.

type ParameterGroup 

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

Manages a Neptune Parameter Group

func GetParameterGroup 

func GetParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ParameterGroupState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ParameterGroup, error)

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

func (*ParameterGroup) Arn 

func (r *ParameterGroup) Arn() *pulumi.StringOutput

The Neptune parameter group Amazon Resource Name (ARN).

func (*ParameterGroup) Description 

func (r *ParameterGroup) Description() *pulumi.StringOutput

The description of the Neptune parameter group. Defaults to "Managed by Terraform".

func (*ParameterGroup) Family 

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

The family of the Neptune parameter group.

func (*ParameterGroup) ID 

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

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

func (*ParameterGroup) Name 

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

The name of the Neptune parameter.

func (*ParameterGroup) Parameters 

func (r *ParameterGroup) Parameters() *pulumi.ArrayOutput

A list of Neptune parameters to apply.

func (*ParameterGroup) Tags 

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

A mapping of tags to assign to the resource.

func (*ParameterGroup) URN 

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

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

type ParameterGroupArgs 

type ParameterGroupArgs struct {
	// The description of the Neptune parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the Neptune parameter group.
	Family interface{}
	// The name of the Neptune parameter.
	Name interface{}
	// A list of Neptune parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a ParameterGroup resource.

type ParameterGroupState 

type ParameterGroupState struct {
	// The Neptune parameter group Amazon Resource Name (ARN).
	Arn interface{}
	// The description of the Neptune parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the Neptune parameter group.
	Family interface{}
	// The name of the Neptune parameter.
	Name interface{}
	// A list of Neptune parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering ParameterGroup resources.

type SubnetGroup 

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

Provides an Neptune subnet group resource.

func GetSubnetGroup 

func GetSubnetGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SubnetGroupState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*SubnetGroup, error)

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

func (*SubnetGroup) Arn 

func (r *SubnetGroup) Arn() *pulumi.StringOutput

The ARN of the neptune subnet group.

func (*SubnetGroup) Description 

func (r *SubnetGroup) Description() *pulumi.StringOutput

The description of the neptune subnet group. Defaults to "Managed by Terraform".

func (*SubnetGroup) ID 

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

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

func (*SubnetGroup) Name 

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

The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.

func (*SubnetGroup) NamePrefix 

func (r *SubnetGroup) NamePrefix() *pulumi.StringOutput

Creates a unique name beginning with the specified prefix. Conflicts with `name`.

func (*SubnetGroup) SubnetIds 

func (r *SubnetGroup) SubnetIds() *pulumi.ArrayOutput

A list of VPC subnet IDs.

func (*SubnetGroup) Tags 

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

A mapping of tags to assign to the resource.

func (*SubnetGroup) URN 

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

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

type SubnetGroupArgs 

type SubnetGroupArgs struct {
	// The description of the neptune subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a SubnetGroup resource.

type SubnetGroupState 

type SubnetGroupState struct {
	// The ARN of the neptune subnet group.
	Arn interface{}
	// The description of the neptune subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering SubnetGroup resources.

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.