Documentation ¶
Index ¶
- type Cluster
- type ClusterArgs
- type ClusterInput
- type ClusterInstance
- type ClusterInstanceArgs
- type ClusterInstanceInput
- type ClusterInstanceOutput
- type ClusterInstanceState
- type ClusterOutput
- type ClusterParameterGroup
- type ClusterParameterGroupArgs
- type ClusterParameterGroupInput
- type ClusterParameterGroupOutput
- type ClusterParameterGroupParameter
- type ClusterParameterGroupParameterArgs
- func (ClusterParameterGroupParameterArgs) ElementType() reflect.Type
- func (i ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutput() ClusterParameterGroupParameterOutput
- func (i ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutputWithContext(ctx context.Context) ClusterParameterGroupParameterOutput
- type ClusterParameterGroupParameterArray
- func (ClusterParameterGroupParameterArray) ElementType() reflect.Type
- func (i ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutput() ClusterParameterGroupParameterArrayOutput
- func (i ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutputWithContext(ctx context.Context) ClusterParameterGroupParameterArrayOutput
- type ClusterParameterGroupParameterArrayInput
- type ClusterParameterGroupParameterArrayOutput
- func (ClusterParameterGroupParameterArrayOutput) ElementType() reflect.Type
- func (o ClusterParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ClusterParameterGroupParameterOutput
- func (o ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutput() ClusterParameterGroupParameterArrayOutput
- func (o ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutputWithContext(ctx context.Context) ClusterParameterGroupParameterArrayOutput
- type ClusterParameterGroupParameterInput
- type ClusterParameterGroupParameterOutput
- func (o ClusterParameterGroupParameterOutput) ApplyMethod() pulumi.StringPtrOutput
- func (ClusterParameterGroupParameterOutput) ElementType() reflect.Type
- func (o ClusterParameterGroupParameterOutput) Name() pulumi.StringOutput
- func (o ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutput() ClusterParameterGroupParameterOutput
- func (o ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutputWithContext(ctx context.Context) ClusterParameterGroupParameterOutput
- func (o ClusterParameterGroupParameterOutput) Value() pulumi.StringOutput
- type ClusterParameterGroupState
- type ClusterSnapshot
- type ClusterSnapshotArgs
- type ClusterSnapshotInput
- type ClusterSnapshotOutput
- type ClusterSnapshotState
- type ClusterState
- type EventSubscription
- type EventSubscriptionArgs
- type EventSubscriptionInput
- type EventSubscriptionOutput
- type EventSubscriptionState
- type GetEngineVersionArgs
- type GetEngineVersionResult
- type GetOrderableDbInstanceArgs
- type GetOrderableDbInstanceResult
- type ParameterGroup
- type ParameterGroupArgs
- type ParameterGroupInput
- type ParameterGroupOutput
- type ParameterGroupParameter
- type ParameterGroupParameterArgs
- type ParameterGroupParameterArray
- func (ParameterGroupParameterArray) ElementType() reflect.Type
- func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
- func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
- type ParameterGroupParameterArrayInput
- type ParameterGroupParameterArrayOutput
- func (ParameterGroupParameterArrayOutput) ElementType() reflect.Type
- func (o ParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ParameterGroupParameterOutput
- func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
- func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
- type ParameterGroupParameterInput
- type ParameterGroupParameterOutput
- func (o ParameterGroupParameterOutput) ApplyMethod() pulumi.StringPtrOutput
- func (ParameterGroupParameterOutput) ElementType() reflect.Type
- func (o ParameterGroupParameterOutput) Name() pulumi.StringOutput
- func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput
- func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput
- func (o ParameterGroupParameterOutput) Value() pulumi.StringOutput
- type ParameterGroupState
- type SubnetGroup
- type SubnetGroupArgs
- type SubnetGroupInput
- type SubnetGroupOutput
- type SubnetGroupState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct { pulumi.CustomResourceState // Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. ApplyImmediately pulumi.BoolOutput `pulumi:"applyImmediately"` // The Neptune Cluster Amazon Resource Name (ARN) Arn pulumi.StringOutput `pulumi:"arn"` // A list of EC2 Availability Zones that instances in the Neptune cluster can be created in. AvailabilityZones pulumi.StringArrayOutput `pulumi:"availabilityZones"` // The days to retain backups for. Default `1` BackupRetentionPeriod pulumi.IntPtrOutput `pulumi:"backupRetentionPeriod"` // The cluster identifier. If omitted, this provider will assign a random, unique identifier. ClusterIdentifier pulumi.StringOutput `pulumi:"clusterIdentifier"` // Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`. ClusterIdentifierPrefix pulumi.StringOutput `pulumi:"clusterIdentifierPrefix"` // List of Neptune Instances that are a part of this cluster ClusterMembers pulumi.StringArrayOutput `pulumi:"clusterMembers"` // The Neptune Cluster Resource ID ClusterResourceId pulumi.StringOutput `pulumi:"clusterResourceId"` // A value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. DeletionProtection pulumi.BoolPtrOutput `pulumi:"deletionProtection"` // A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit`. EnableCloudwatchLogsExports pulumi.StringArrayOutput `pulumi:"enableCloudwatchLogsExports"` // The DNS address of the Neptune instance Endpoint pulumi.StringOutput `pulumi:"endpoint"` // The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`. Engine pulumi.StringPtrOutput `pulumi:"engine"` // The database engine version. EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` // The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made. FinalSnapshotIdentifier pulumi.StringPtrOutput `pulumi:"finalSnapshotIdentifier"` // The Route53 Hosted Zone ID of the endpoint HostedZoneId pulumi.StringOutput `pulumi:"hostedZoneId"` // Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. IamDatabaseAuthenticationEnabled pulumi.BoolPtrOutput `pulumi:"iamDatabaseAuthenticationEnabled"` // A List of ARNs for the IAM roles to associate to the Neptune Cluster. IamRoles pulumi.StringArrayOutput `pulumi:"iamRoles"` // The ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true. KmsKeyArn pulumi.StringOutput `pulumi:"kmsKeyArn"` // A cluster parameter group to associate with the cluster. NeptuneClusterParameterGroupName pulumi.StringPtrOutput `pulumi:"neptuneClusterParameterGroupName"` // A Neptune subnet group to associate with this Neptune instance. NeptuneSubnetGroupName pulumi.StringOutput `pulumi:"neptuneSubnetGroupName"` // The port on which the Neptune accepts connections. Default is `8182`. Port pulumi.IntPtrOutput `pulumi:"port"` // 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 pulumi.StringOutput `pulumi:"preferredBackupWindow"` // The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30 PreferredMaintenanceWindow pulumi.StringOutput `pulumi:"preferredMaintenanceWindow"` // A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas ReaderEndpoint pulumi.StringOutput `pulumi:"readerEndpoint"` // ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. ReplicationSourceIdentifier pulumi.StringPtrOutput `pulumi:"replicationSourceIdentifier"` // 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 `finalSnapshotIdentifier`. Default is `false`. SkipFinalSnapshot pulumi.BoolPtrOutput `pulumi:"skipFinalSnapshot"` // 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 pulumi.StringPtrOutput `pulumi:"snapshotIdentifier"` // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrOutput `pulumi:"storageEncrypted"` // A map of tags to assign to the Neptune cluster. Tags pulumi.StringMapOutput `pulumi:"tags"` // List of VPC security groups to associate with the Cluster VpcSecurityGroupIds pulumi.StringArrayOutput `pulumi:"vpcSecurityGroupIds"` }
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 `backupRetentionPeriod`, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the `applyImmediately` flag to instruct the service to apply the change immediately (see documentation below).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewCluster(ctx, "_default", &neptune.ClusterArgs{ ApplyImmediately: pulumi.Bool(true), BackupRetentionPeriod: pulumi.Int(5), ClusterIdentifier: pulumi.String("neptune-cluster-demo"), Engine: pulumi.String("neptune"), IamDatabaseAuthenticationEnabled: pulumi.Bool(true), PreferredBackupWindow: pulumi.String("07:00-09:00"), SkipFinalSnapshot: pulumi.Bool(true), }) if err != nil { return err } return nil }) }
```
> **Note:** AWS Neptune does not support user name/password–based access control. See the AWS [Docs](https://docs.aws.amazon.com/neptune/latest/userguide/limits.html) for more information.
## Import
`aws_neptune_cluster` can be imported by using the cluster identifier, e.g.
```sh
$ pulumi import aws:neptune/cluster:Cluster example my-cluster
```
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.
func (Cluster) ElementType ¶ added in v3.13.0
func (Cluster) ToClusterOutput ¶ added in v3.13.0
func (i Cluster) ToClusterOutput() ClusterOutput
func (Cluster) ToClusterOutputWithContext ¶ added in v3.13.0
func (i Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
type ClusterArgs ¶
type ClusterArgs struct { // Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. ApplyImmediately pulumi.BoolPtrInput // A list of EC2 Availability Zones that instances in the Neptune cluster can be created in. AvailabilityZones pulumi.StringArrayInput // The days to retain backups for. Default `1` BackupRetentionPeriod pulumi.IntPtrInput // The cluster identifier. If omitted, this provider will assign a random, unique identifier. ClusterIdentifier pulumi.StringPtrInput // Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`. ClusterIdentifierPrefix pulumi.StringPtrInput // A value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. DeletionProtection pulumi.BoolPtrInput // A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit`. EnableCloudwatchLogsExports pulumi.StringArrayInput // The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`. Engine pulumi.StringPtrInput // The database engine version. EngineVersion pulumi.StringPtrInput // The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made. FinalSnapshotIdentifier pulumi.StringPtrInput // Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. IamDatabaseAuthenticationEnabled pulumi.BoolPtrInput // A List of ARNs for the IAM roles to associate to the Neptune Cluster. IamRoles pulumi.StringArrayInput // The ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true. KmsKeyArn pulumi.StringPtrInput // A cluster parameter group to associate with the cluster. NeptuneClusterParameterGroupName pulumi.StringPtrInput // A Neptune subnet group to associate with this Neptune instance. NeptuneSubnetGroupName pulumi.StringPtrInput // The port on which the Neptune accepts connections. Default is `8182`. Port pulumi.IntPtrInput // 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 pulumi.StringPtrInput // The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30 PreferredMaintenanceWindow pulumi.StringPtrInput // ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. ReplicationSourceIdentifier pulumi.StringPtrInput // 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 `finalSnapshotIdentifier`. Default is `false`. SkipFinalSnapshot pulumi.BoolPtrInput // 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 pulumi.StringPtrInput // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrInput // A map of tags to assign to the Neptune cluster. Tags pulumi.StringMapInput // List of VPC security groups to associate with the Cluster VpcSecurityGroupIds pulumi.StringArrayInput }
The set of arguments for constructing a Cluster resource.
func (ClusterArgs) ElementType ¶
func (ClusterArgs) ElementType() reflect.Type
type ClusterInput ¶ added in v3.13.0
type ClusterInput interface { pulumi.Input ToClusterOutput() ClusterOutput ToClusterOutputWithContext(ctx context.Context) ClusterOutput }
type ClusterInstance ¶
type ClusterInstance struct { pulumi.CustomResourceState // The hostname of the instance. See also `endpoint` and `port`. Address pulumi.StringOutput `pulumi:"address"` // Specifies whether any instance modifications // are applied immediately, or during the next maintenance window. Default is`false`. ApplyImmediately pulumi.BoolOutput `pulumi:"applyImmediately"` // Amazon Resource Name (ARN) of neptune instance Arn pulumi.StringOutput `pulumi:"arn"` // Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`. AutoMinorVersionUpgrade pulumi.BoolPtrOutput `pulumi:"autoMinorVersionUpgrade"` // The EC2 Availability Zone that the neptune instance is created in. AvailabilityZone pulumi.StringOutput `pulumi:"availabilityZone"` // The identifier of the `neptune.Cluster` in which to launch this instance. ClusterIdentifier pulumi.StringOutput `pulumi:"clusterIdentifier"` // The region-unique, immutable identifier for the neptune instance. DbiResourceId pulumi.StringOutput `pulumi:"dbiResourceId"` // The connection endpoint in `address:port` format. Endpoint pulumi.StringOutput `pulumi:"endpoint"` // The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`. Engine pulumi.StringPtrOutput `pulumi:"engine"` // The neptune engine version. EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` // The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier. Identifier pulumi.StringOutput `pulumi:"identifier"` // Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. IdentifierPrefix pulumi.StringOutput `pulumi:"identifierPrefix"` // The instance class to use. InstanceClass pulumi.StringOutput `pulumi:"instanceClass"` // The ARN for the KMS encryption key if one is set to the neptune cluster. KmsKeyArn pulumi.StringOutput `pulumi:"kmsKeyArn"` // The name of the neptune parameter group to associate with this instance. NeptuneParameterGroupName pulumi.StringPtrOutput `pulumi:"neptuneParameterGroupName"` // A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptuneSubnetGroupName` of the attached `neptune.Cluster`. NeptuneSubnetGroupName pulumi.StringOutput `pulumi:"neptuneSubnetGroupName"` // The port on which the DB accepts connections. Defaults to `8182`. Port pulumi.IntPtrOutput `pulumi:"port"` // The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00" PreferredBackupWindow pulumi.StringOutput `pulumi:"preferredBackupWindow"` // The window to perform maintenance in. // Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". PreferredMaintenanceWindow pulumi.StringOutput `pulumi:"preferredMaintenanceWindow"` // Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer. PromotionTier pulumi.IntPtrOutput `pulumi:"promotionTier"` // Bool to control if instance is publicly accessible. Default is `false`. PubliclyAccessible pulumi.BoolPtrOutput `pulumi:"publiclyAccessible"` // Specifies whether the neptune cluster is encrypted. StorageEncrypted pulumi.BoolOutput `pulumi:"storageEncrypted"` // A map of tags to assign to the instance. Tags pulumi.StringMapOutput `pulumi:"tags"` // Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. Writer pulumi.BoolOutput `pulumi:"writer"` }
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](https://www.terraform.io/docs/configuration/resources.html#count) 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 `instanceClass` sizes.
## Example Usage
The following example will create a neptune cluster with two neptune instances(one writer and one reader).
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewCluster(ctx, "_default", &neptune.ClusterArgs{ ClusterIdentifier: pulumi.String("neptune-cluster-demo"), Engine: pulumi.String("neptune"), BackupRetentionPeriod: pulumi.Int(5), PreferredBackupWindow: pulumi.String("07:00-09:00"), SkipFinalSnapshot: pulumi.Bool(true), IamDatabaseAuthenticationEnabled: pulumi.Bool(true), ApplyImmediately: pulumi.Bool(true), }) if err != nil { return err } var example []*neptune.ClusterInstance for key0, _ := range 2 { __res, err := neptune.NewClusterInstance(ctx, fmt.Sprintf("example-%v", key0), &neptune.ClusterInstanceArgs{ ClusterIdentifier: _default.ID(), Engine: pulumi.String("neptune"), InstanceClass: pulumi.String("db.r4.large"), ApplyImmediately: pulumi.Bool(true), }) if err != nil { return err } example = append(example, __res) } return nil }) }
```
## Import
`aws_neptune_cluster_instance` can be imported by using the instance identifier, e.g.
```sh
$ pulumi import aws:neptune/clusterInstance:ClusterInstance example my-instance
```
func GetClusterInstance ¶
func GetClusterInstance(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ClusterInstanceState, opts ...pulumi.ResourceOption) (*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 ¶
func NewClusterInstance(ctx *pulumi.Context, name string, args *ClusterInstanceArgs, opts ...pulumi.ResourceOption) (*ClusterInstance, error)
NewClusterInstance registers a new resource with the given unique name, arguments, and options.
func (ClusterInstance) ElementType ¶ added in v3.13.0
func (ClusterInstance) ElementType() reflect.Type
func (ClusterInstance) ToClusterInstanceOutput ¶ added in v3.13.0
func (i ClusterInstance) ToClusterInstanceOutput() ClusterInstanceOutput
func (ClusterInstance) ToClusterInstanceOutputWithContext ¶ added in v3.13.0
func (i ClusterInstance) ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput
type ClusterInstanceArgs ¶
type ClusterInstanceArgs struct { // Specifies whether any instance modifications // are applied immediately, or during the next maintenance window. Default is`false`. ApplyImmediately pulumi.BoolPtrInput // Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`. AutoMinorVersionUpgrade pulumi.BoolPtrInput // The EC2 Availability Zone that the neptune instance is created in. AvailabilityZone pulumi.StringPtrInput // The identifier of the `neptune.Cluster` in which to launch this instance. ClusterIdentifier pulumi.StringInput // The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`. Engine pulumi.StringPtrInput // The neptune engine version. EngineVersion pulumi.StringPtrInput // The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier. Identifier pulumi.StringPtrInput // Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. IdentifierPrefix pulumi.StringPtrInput // The instance class to use. InstanceClass pulumi.StringInput // The name of the neptune parameter group to associate with this instance. NeptuneParameterGroupName pulumi.StringPtrInput // A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptuneSubnetGroupName` of the attached `neptune.Cluster`. NeptuneSubnetGroupName pulumi.StringPtrInput // The port on which the DB accepts connections. Defaults to `8182`. Port pulumi.IntPtrInput // The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00" PreferredBackupWindow pulumi.StringPtrInput // The window to perform maintenance in. // Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". PreferredMaintenanceWindow pulumi.StringPtrInput // Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer. PromotionTier pulumi.IntPtrInput // Bool to control if instance is publicly accessible. Default is `false`. PubliclyAccessible pulumi.BoolPtrInput // A map of tags to assign to the instance. Tags pulumi.StringMapInput }
The set of arguments for constructing a ClusterInstance resource.
func (ClusterInstanceArgs) ElementType ¶
func (ClusterInstanceArgs) ElementType() reflect.Type
type ClusterInstanceInput ¶ added in v3.13.0
type ClusterInstanceInput interface { pulumi.Input ToClusterInstanceOutput() ClusterInstanceOutput ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput }
type ClusterInstanceOutput ¶ added in v3.13.0
type ClusterInstanceOutput struct {
*pulumi.OutputState
}
func (ClusterInstanceOutput) ElementType ¶ added in v3.13.0
func (ClusterInstanceOutput) ElementType() reflect.Type
func (ClusterInstanceOutput) ToClusterInstanceOutput ¶ added in v3.13.0
func (o ClusterInstanceOutput) ToClusterInstanceOutput() ClusterInstanceOutput
func (ClusterInstanceOutput) ToClusterInstanceOutputWithContext ¶ added in v3.13.0
func (o ClusterInstanceOutput) ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput
type ClusterInstanceState ¶
type ClusterInstanceState struct { // The hostname of the instance. See also `endpoint` and `port`. Address pulumi.StringPtrInput // Specifies whether any instance modifications // are applied immediately, or during the next maintenance window. Default is`false`. ApplyImmediately pulumi.BoolPtrInput // Amazon Resource Name (ARN) of neptune instance Arn pulumi.StringPtrInput // Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`. AutoMinorVersionUpgrade pulumi.BoolPtrInput // The EC2 Availability Zone that the neptune instance is created in. AvailabilityZone pulumi.StringPtrInput // The identifier of the `neptune.Cluster` in which to launch this instance. ClusterIdentifier pulumi.StringPtrInput // The region-unique, immutable identifier for the neptune instance. DbiResourceId pulumi.StringPtrInput // The connection endpoint in `address:port` format. Endpoint pulumi.StringPtrInput // The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`. Engine pulumi.StringPtrInput // The neptune engine version. EngineVersion pulumi.StringPtrInput // The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier. Identifier pulumi.StringPtrInput // Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. IdentifierPrefix pulumi.StringPtrInput // The instance class to use. InstanceClass pulumi.StringPtrInput // The ARN for the KMS encryption key if one is set to the neptune cluster. KmsKeyArn pulumi.StringPtrInput // The name of the neptune parameter group to associate with this instance. NeptuneParameterGroupName pulumi.StringPtrInput // A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptuneSubnetGroupName` of the attached `neptune.Cluster`. NeptuneSubnetGroupName pulumi.StringPtrInput // The port on which the DB accepts connections. Defaults to `8182`. Port pulumi.IntPtrInput // The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00" PreferredBackupWindow pulumi.StringPtrInput // The window to perform maintenance in. // Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". PreferredMaintenanceWindow pulumi.StringPtrInput // Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer. PromotionTier pulumi.IntPtrInput // Bool to control if instance is publicly accessible. Default is `false`. PubliclyAccessible pulumi.BoolPtrInput // Specifies whether the neptune cluster is encrypted. StorageEncrypted pulumi.BoolPtrInput // A map of tags to assign to the instance. Tags pulumi.StringMapInput // Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. Writer pulumi.BoolPtrInput }
func (ClusterInstanceState) ElementType ¶
func (ClusterInstanceState) ElementType() reflect.Type
type ClusterOutput ¶ added in v3.13.0
type ClusterOutput struct {
*pulumi.OutputState
}
func (ClusterOutput) ElementType ¶ added in v3.13.0
func (ClusterOutput) ElementType() reflect.Type
func (ClusterOutput) ToClusterOutput ¶ added in v3.13.0
func (o ClusterOutput) ToClusterOutput() ClusterOutput
func (ClusterOutput) ToClusterOutputWithContext ¶ added in v3.13.0
func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
type ClusterParameterGroup ¶
type ClusterParameterGroup struct { pulumi.CustomResourceState // The ARN of the neptune cluster parameter group. Arn pulumi.StringOutput `pulumi:"arn"` // The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrOutput `pulumi:"description"` // The family of the neptune cluster parameter group. Family pulumi.StringOutput `pulumi:"family"` // The name of the neptune parameter. Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // A list of neptune parameters to apply. Parameters ClusterParameterGroupParameterArrayOutput `pulumi:"parameters"` // A map of tags to assign to the resource. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Manages a Neptune Cluster Parameter Group
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewClusterParameterGroup(ctx, "example", &neptune.ClusterParameterGroupArgs{ Description: pulumi.String("neptune cluster parameter group"), Family: pulumi.String("neptune1"), Parameters: neptune.ClusterParameterGroupParameterArray{ &neptune.ClusterParameterGroupParameterArgs{ Name: pulumi.String("neptune_enable_audit_log"), Value: pulumi.String("1"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Neptune Cluster Parameter Groups can be imported using the `name`, e.g.
```sh
$ pulumi import aws:neptune/clusterParameterGroup:ClusterParameterGroup cluster_pg production-pg-1
```
func GetClusterParameterGroup ¶
func GetClusterParameterGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ClusterParameterGroupState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*ClusterParameterGroup, error)
NewClusterParameterGroup registers a new resource with the given unique name, arguments, and options.
func (ClusterParameterGroup) ElementType ¶ added in v3.13.0
func (ClusterParameterGroup) ElementType() reflect.Type
func (ClusterParameterGroup) ToClusterParameterGroupOutput ¶ added in v3.13.0
func (i ClusterParameterGroup) ToClusterParameterGroupOutput() ClusterParameterGroupOutput
func (ClusterParameterGroup) ToClusterParameterGroupOutputWithContext ¶ added in v3.13.0
func (i ClusterParameterGroup) ToClusterParameterGroupOutputWithContext(ctx context.Context) ClusterParameterGroupOutput
type ClusterParameterGroupArgs ¶
type ClusterParameterGroupArgs struct { // The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The family of the neptune cluster parameter group. Family pulumi.StringInput // The name of the neptune parameter. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of neptune parameters to apply. Parameters ClusterParameterGroupParameterArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
The set of arguments for constructing a ClusterParameterGroup resource.
func (ClusterParameterGroupArgs) ElementType ¶
func (ClusterParameterGroupArgs) ElementType() reflect.Type
type ClusterParameterGroupInput ¶ added in v3.13.0
type ClusterParameterGroupInput interface { pulumi.Input ToClusterParameterGroupOutput() ClusterParameterGroupOutput ToClusterParameterGroupOutputWithContext(ctx context.Context) ClusterParameterGroupOutput }
type ClusterParameterGroupOutput ¶ added in v3.13.0
type ClusterParameterGroupOutput struct {
*pulumi.OutputState
}
func (ClusterParameterGroupOutput) ElementType ¶ added in v3.13.0
func (ClusterParameterGroupOutput) ElementType() reflect.Type
func (ClusterParameterGroupOutput) ToClusterParameterGroupOutput ¶ added in v3.13.0
func (o ClusterParameterGroupOutput) ToClusterParameterGroupOutput() ClusterParameterGroupOutput
func (ClusterParameterGroupOutput) ToClusterParameterGroupOutputWithContext ¶ added in v3.13.0
func (o ClusterParameterGroupOutput) ToClusterParameterGroupOutputWithContext(ctx context.Context) ClusterParameterGroupOutput
type ClusterParameterGroupParameter ¶
type ClusterParameterGroupParameter struct { // Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`. ApplyMethod *string `pulumi:"applyMethod"` // The name of the neptune parameter. Name string `pulumi:"name"` // The value of the neptune parameter. Value string `pulumi:"value"` }
type ClusterParameterGroupParameterArgs ¶
type ClusterParameterGroupParameterArgs struct { // Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`. ApplyMethod pulumi.StringPtrInput `pulumi:"applyMethod"` // The name of the neptune parameter. Name pulumi.StringInput `pulumi:"name"` // The value of the neptune parameter. Value pulumi.StringInput `pulumi:"value"` }
func (ClusterParameterGroupParameterArgs) ElementType ¶
func (ClusterParameterGroupParameterArgs) ElementType() reflect.Type
func (ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutput ¶
func (i ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutput() ClusterParameterGroupParameterOutput
func (ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutputWithContext ¶
func (i ClusterParameterGroupParameterArgs) ToClusterParameterGroupParameterOutputWithContext(ctx context.Context) ClusterParameterGroupParameterOutput
type ClusterParameterGroupParameterArray ¶
type ClusterParameterGroupParameterArray []ClusterParameterGroupParameterInput
func (ClusterParameterGroupParameterArray) ElementType ¶
func (ClusterParameterGroupParameterArray) ElementType() reflect.Type
func (ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutput ¶
func (i ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutput() ClusterParameterGroupParameterArrayOutput
func (ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutputWithContext ¶
func (i ClusterParameterGroupParameterArray) ToClusterParameterGroupParameterArrayOutputWithContext(ctx context.Context) ClusterParameterGroupParameterArrayOutput
type ClusterParameterGroupParameterArrayInput ¶
type ClusterParameterGroupParameterArrayInput interface { pulumi.Input ToClusterParameterGroupParameterArrayOutput() ClusterParameterGroupParameterArrayOutput ToClusterParameterGroupParameterArrayOutputWithContext(context.Context) ClusterParameterGroupParameterArrayOutput }
ClusterParameterGroupParameterArrayInput is an input type that accepts ClusterParameterGroupParameterArray and ClusterParameterGroupParameterArrayOutput values. You can construct a concrete instance of `ClusterParameterGroupParameterArrayInput` via:
ClusterParameterGroupParameterArray{ ClusterParameterGroupParameterArgs{...} }
type ClusterParameterGroupParameterArrayOutput ¶
type ClusterParameterGroupParameterArrayOutput struct{ *pulumi.OutputState }
func (ClusterParameterGroupParameterArrayOutput) ElementType ¶
func (ClusterParameterGroupParameterArrayOutput) ElementType() reflect.Type
func (ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutput ¶
func (o ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutput() ClusterParameterGroupParameterArrayOutput
func (ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutputWithContext ¶
func (o ClusterParameterGroupParameterArrayOutput) ToClusterParameterGroupParameterArrayOutputWithContext(ctx context.Context) ClusterParameterGroupParameterArrayOutput
type ClusterParameterGroupParameterInput ¶
type ClusterParameterGroupParameterInput interface { pulumi.Input ToClusterParameterGroupParameterOutput() ClusterParameterGroupParameterOutput ToClusterParameterGroupParameterOutputWithContext(context.Context) ClusterParameterGroupParameterOutput }
ClusterParameterGroupParameterInput is an input type that accepts ClusterParameterGroupParameterArgs and ClusterParameterGroupParameterOutput values. You can construct a concrete instance of `ClusterParameterGroupParameterInput` via:
ClusterParameterGroupParameterArgs{...}
type ClusterParameterGroupParameterOutput ¶
type ClusterParameterGroupParameterOutput struct{ *pulumi.OutputState }
func (ClusterParameterGroupParameterOutput) ApplyMethod ¶
func (o ClusterParameterGroupParameterOutput) ApplyMethod() pulumi.StringPtrOutput
Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`.
func (ClusterParameterGroupParameterOutput) ElementType ¶
func (ClusterParameterGroupParameterOutput) ElementType() reflect.Type
func (ClusterParameterGroupParameterOutput) Name ¶
func (o ClusterParameterGroupParameterOutput) Name() pulumi.StringOutput
The name of the neptune parameter.
func (ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutput ¶
func (o ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutput() ClusterParameterGroupParameterOutput
func (ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutputWithContext ¶
func (o ClusterParameterGroupParameterOutput) ToClusterParameterGroupParameterOutputWithContext(ctx context.Context) ClusterParameterGroupParameterOutput
func (ClusterParameterGroupParameterOutput) Value ¶
func (o ClusterParameterGroupParameterOutput) Value() pulumi.StringOutput
The value of the neptune parameter.
type ClusterParameterGroupState ¶
type ClusterParameterGroupState struct { // The ARN of the neptune cluster parameter group. Arn pulumi.StringPtrInput // The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The family of the neptune cluster parameter group. Family pulumi.StringPtrInput // The name of the neptune parameter. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of neptune parameters to apply. Parameters ClusterParameterGroupParameterArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
func (ClusterParameterGroupState) ElementType ¶
func (ClusterParameterGroupState) ElementType() reflect.Type
type ClusterSnapshot ¶
type ClusterSnapshot struct { pulumi.CustomResourceState // Specifies the allocated storage size in gigabytes (GB). AllocatedStorage pulumi.IntOutput `pulumi:"allocatedStorage"` // List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. AvailabilityZones pulumi.StringArrayOutput `pulumi:"availabilityZones"` // The DB Cluster Identifier from which to take the snapshot. DbClusterIdentifier pulumi.StringOutput `pulumi:"dbClusterIdentifier"` // The Amazon Resource Name (ARN) for the DB Cluster Snapshot. DbClusterSnapshotArn pulumi.StringOutput `pulumi:"dbClusterSnapshotArn"` // The Identifier for the snapshot. DbClusterSnapshotIdentifier pulumi.StringOutput `pulumi:"dbClusterSnapshotIdentifier"` // Specifies the name of the database engine. Engine pulumi.StringOutput `pulumi:"engine"` // Version of the database engine for this DB cluster snapshot. EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` // If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. KmsKeyId pulumi.StringOutput `pulumi:"kmsKeyId"` // License model information for the restored DB cluster. LicenseModel pulumi.StringOutput `pulumi:"licenseModel"` // Port that the DB cluster was listening on at the time of the snapshot. Port pulumi.IntOutput `pulumi:"port"` SnapshotType pulumi.StringOutput `pulumi:"snapshotType"` SourceDbClusterSnapshotArn pulumi.StringOutput `pulumi:"sourceDbClusterSnapshotArn"` // The status of this DB Cluster Snapshot. Status pulumi.StringOutput `pulumi:"status"` // Specifies whether the DB cluster snapshot is encrypted. StorageEncrypted pulumi.BoolOutput `pulumi:"storageEncrypted"` // The VPC ID associated with the DB cluster snapshot. VpcId pulumi.StringOutput `pulumi:"vpcId"` }
Manages a Neptune database cluster snapshot.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewClusterSnapshot(ctx, "example", &neptune.ClusterSnapshotArgs{ DbClusterIdentifier: pulumi.Any(aws_neptune_cluster.Example.Id), DbClusterSnapshotIdentifier: pulumi.String("resourcetestsnapshot1234"), }) if err != nil { return err } return nil }) }
```
## Import
`aws_neptune_cluster_snapshot` can be imported by using the cluster snapshot identifier, e.g.
```sh
$ pulumi import aws:neptune/clusterSnapshot:ClusterSnapshot example my-cluster-snapshot
```
func GetClusterSnapshot ¶
func GetClusterSnapshot(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ClusterSnapshotState, opts ...pulumi.ResourceOption) (*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 ¶
func NewClusterSnapshot(ctx *pulumi.Context, name string, args *ClusterSnapshotArgs, opts ...pulumi.ResourceOption) (*ClusterSnapshot, error)
NewClusterSnapshot registers a new resource with the given unique name, arguments, and options.
func (ClusterSnapshot) ElementType ¶ added in v3.13.0
func (ClusterSnapshot) ElementType() reflect.Type
func (ClusterSnapshot) ToClusterSnapshotOutput ¶ added in v3.13.0
func (i ClusterSnapshot) ToClusterSnapshotOutput() ClusterSnapshotOutput
func (ClusterSnapshot) ToClusterSnapshotOutputWithContext ¶ added in v3.13.0
func (i ClusterSnapshot) ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput
type ClusterSnapshotArgs ¶
type ClusterSnapshotArgs struct { // The DB Cluster Identifier from which to take the snapshot. DbClusterIdentifier pulumi.StringInput // The Identifier for the snapshot. DbClusterSnapshotIdentifier pulumi.StringInput }
The set of arguments for constructing a ClusterSnapshot resource.
func (ClusterSnapshotArgs) ElementType ¶
func (ClusterSnapshotArgs) ElementType() reflect.Type
type ClusterSnapshotInput ¶ added in v3.13.0
type ClusterSnapshotInput interface { pulumi.Input ToClusterSnapshotOutput() ClusterSnapshotOutput ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput }
type ClusterSnapshotOutput ¶ added in v3.13.0
type ClusterSnapshotOutput struct {
*pulumi.OutputState
}
func (ClusterSnapshotOutput) ElementType ¶ added in v3.13.0
func (ClusterSnapshotOutput) ElementType() reflect.Type
func (ClusterSnapshotOutput) ToClusterSnapshotOutput ¶ added in v3.13.0
func (o ClusterSnapshotOutput) ToClusterSnapshotOutput() ClusterSnapshotOutput
func (ClusterSnapshotOutput) ToClusterSnapshotOutputWithContext ¶ added in v3.13.0
func (o ClusterSnapshotOutput) ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput
type ClusterSnapshotState ¶
type ClusterSnapshotState struct { // Specifies the allocated storage size in gigabytes (GB). AllocatedStorage pulumi.IntPtrInput // List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. AvailabilityZones pulumi.StringArrayInput // The DB Cluster Identifier from which to take the snapshot. DbClusterIdentifier pulumi.StringPtrInput // The Amazon Resource Name (ARN) for the DB Cluster Snapshot. DbClusterSnapshotArn pulumi.StringPtrInput // The Identifier for the snapshot. DbClusterSnapshotIdentifier pulumi.StringPtrInput // Specifies the name of the database engine. Engine pulumi.StringPtrInput // Version of the database engine for this DB cluster snapshot. EngineVersion pulumi.StringPtrInput // If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. KmsKeyId pulumi.StringPtrInput // License model information for the restored DB cluster. LicenseModel pulumi.StringPtrInput // Port that the DB cluster was listening on at the time of the snapshot. Port pulumi.IntPtrInput SnapshotType pulumi.StringPtrInput SourceDbClusterSnapshotArn pulumi.StringPtrInput // The status of this DB Cluster Snapshot. Status pulumi.StringPtrInput // Specifies whether the DB cluster snapshot is encrypted. StorageEncrypted pulumi.BoolPtrInput // The VPC ID associated with the DB cluster snapshot. VpcId pulumi.StringPtrInput }
func (ClusterSnapshotState) ElementType ¶
func (ClusterSnapshotState) ElementType() reflect.Type
type ClusterState ¶
type ClusterState struct { // Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. ApplyImmediately pulumi.BoolPtrInput // The Neptune Cluster Amazon Resource Name (ARN) Arn pulumi.StringPtrInput // A list of EC2 Availability Zones that instances in the Neptune cluster can be created in. AvailabilityZones pulumi.StringArrayInput // The days to retain backups for. Default `1` BackupRetentionPeriod pulumi.IntPtrInput // The cluster identifier. If omitted, this provider will assign a random, unique identifier. ClusterIdentifier pulumi.StringPtrInput // Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`. ClusterIdentifierPrefix pulumi.StringPtrInput // List of Neptune Instances that are a part of this cluster ClusterMembers pulumi.StringArrayInput // The Neptune Cluster Resource ID ClusterResourceId pulumi.StringPtrInput // A value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. DeletionProtection pulumi.BoolPtrInput // A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit`. EnableCloudwatchLogsExports pulumi.StringArrayInput // The DNS address of the Neptune instance Endpoint pulumi.StringPtrInput // The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`. Engine pulumi.StringPtrInput // The database engine version. EngineVersion pulumi.StringPtrInput // The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made. FinalSnapshotIdentifier pulumi.StringPtrInput // The Route53 Hosted Zone ID of the endpoint HostedZoneId pulumi.StringPtrInput // Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. IamDatabaseAuthenticationEnabled pulumi.BoolPtrInput // A List of ARNs for the IAM roles to associate to the Neptune Cluster. IamRoles pulumi.StringArrayInput // The ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true. KmsKeyArn pulumi.StringPtrInput // A cluster parameter group to associate with the cluster. NeptuneClusterParameterGroupName pulumi.StringPtrInput // A Neptune subnet group to associate with this Neptune instance. NeptuneSubnetGroupName pulumi.StringPtrInput // The port on which the Neptune accepts connections. Default is `8182`. Port pulumi.IntPtrInput // 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 pulumi.StringPtrInput // The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30 PreferredMaintenanceWindow pulumi.StringPtrInput // A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas ReaderEndpoint pulumi.StringPtrInput // ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. ReplicationSourceIdentifier pulumi.StringPtrInput // 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 `finalSnapshotIdentifier`. Default is `false`. SkipFinalSnapshot pulumi.BoolPtrInput // 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 pulumi.StringPtrInput // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrInput // A map of tags to assign to the Neptune cluster. Tags pulumi.StringMapInput // List of VPC security groups to associate with the Cluster VpcSecurityGroupIds pulumi.StringArrayInput }
func (ClusterState) ElementType ¶
func (ClusterState) ElementType() reflect.Type
type EventSubscription ¶
type EventSubscription struct { pulumi.CustomResourceState Arn pulumi.StringOutput `pulumi:"arn"` CustomerAwsId pulumi.StringOutput `pulumi:"customerAwsId"` // A boolean flag to enable/disable the subscription. Defaults to true. Enabled pulumi.BoolPtrOutput `pulumi:"enabled"` // A list of event categories for a `sourceType` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories. EventCategories pulumi.StringArrayOutput `pulumi:"eventCategories"` // The name of the Neptune event subscription. By default generated by this provider. Name pulumi.StringOutput `pulumi:"name"` // The name of the Neptune event subscription. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // The ARN of the SNS topic to send events to. SnsTopicArn pulumi.StringOutput `pulumi:"snsTopicArn"` // 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 `sourceType` must also be specified. SourceIds pulumi.StringArrayOutput `pulumi:"sourceIds"` // 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 pulumi.StringPtrOutput `pulumi:"sourceType"` // A map of tags to assign to the resource. Tags pulumi.StringMapOutput `pulumi:"tags"` }
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/sns" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { defaultCluster, err := neptune.NewCluster(ctx, "defaultCluster", &neptune.ClusterArgs{ ClusterIdentifier: pulumi.String("neptune-cluster-demo"), Engine: pulumi.String("neptune"), BackupRetentionPeriod: pulumi.Int(5), PreferredBackupWindow: pulumi.String("07:00-09:00"), SkipFinalSnapshot: pulumi.Bool(true), IamDatabaseAuthenticationEnabled: pulumi.Bool(true), ApplyImmediately: pulumi.Bool(true), }) if err != nil { return err } example, err := neptune.NewClusterInstance(ctx, "example", &neptune.ClusterInstanceArgs{ ClusterIdentifier: defaultCluster.ID(), Engine: pulumi.String("neptune"), InstanceClass: pulumi.String("db.r4.large"), ApplyImmediately: pulumi.Bool(true), }) if err != nil { return err } defaultTopic, err := sns.NewTopic(ctx, "defaultTopic", nil) if err != nil { return err } _, err = neptune.NewEventSubscription(ctx, "defaultEventSubscription", &neptune.EventSubscriptionArgs{ SnsTopicArn: defaultTopic.Arn, SourceType: pulumi.String("db-instance"), SourceIds: pulumi.StringArray{ example.ID(), }, EventCategories: pulumi.StringArray{ pulumi.String("maintenance"), pulumi.String("availability"), pulumi.String("creation"), pulumi.String("backup"), pulumi.String("restoration"), pulumi.String("recovery"), pulumi.String("deletion"), pulumi.String("failover"), pulumi.String("failure"), pulumi.String("notification"), pulumi.String("configuration change"), pulumi.String("read replica"), }, Tags: pulumi.StringMap{ "env": pulumi.String("test"), }, }) if err != nil { return err } return nil }) }
``` ## Attributes
The following additional atttributes are provided:
* `id` - The name of the Neptune event notification subscription. * `arn` - The Amazon Resource Name of the Neptune event notification subscription. * `customerAwsId` - The AWS customer account associated with the Neptune event notification subscription.
## Import
`aws_neptune_event_subscription` can be imported by using the event subscription name, e.g.
```sh
$ pulumi import aws:neptune/eventSubscription:EventSubscription example my-event-subscription
```
func GetEventSubscription ¶
func GetEventSubscription(ctx *pulumi.Context, name string, id pulumi.IDInput, state *EventSubscriptionState, opts ...pulumi.ResourceOption) (*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 ¶
func NewEventSubscription(ctx *pulumi.Context, name string, args *EventSubscriptionArgs, opts ...pulumi.ResourceOption) (*EventSubscription, error)
NewEventSubscription registers a new resource with the given unique name, arguments, and options.
func (EventSubscription) ElementType ¶ added in v3.13.0
func (EventSubscription) ElementType() reflect.Type
func (EventSubscription) ToEventSubscriptionOutput ¶ added in v3.13.0
func (i EventSubscription) ToEventSubscriptionOutput() EventSubscriptionOutput
func (EventSubscription) ToEventSubscriptionOutputWithContext ¶ added in v3.13.0
func (i EventSubscription) ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput
type EventSubscriptionArgs ¶
type EventSubscriptionArgs struct { // A boolean flag to enable/disable the subscription. Defaults to true. Enabled pulumi.BoolPtrInput // A list of event categories for a `sourceType` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories. EventCategories pulumi.StringArrayInput // The name of the Neptune event subscription. By default generated by this provider. Name pulumi.StringPtrInput // The name of the Neptune event subscription. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // The ARN of the SNS topic to send events to. SnsTopicArn pulumi.StringInput // 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 `sourceType` must also be specified. SourceIds pulumi.StringArrayInput // 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 pulumi.StringPtrInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
The set of arguments for constructing a EventSubscription resource.
func (EventSubscriptionArgs) ElementType ¶
func (EventSubscriptionArgs) ElementType() reflect.Type
type EventSubscriptionInput ¶ added in v3.13.0
type EventSubscriptionInput interface { pulumi.Input ToEventSubscriptionOutput() EventSubscriptionOutput ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput }
type EventSubscriptionOutput ¶ added in v3.13.0
type EventSubscriptionOutput struct {
*pulumi.OutputState
}
func (EventSubscriptionOutput) ElementType ¶ added in v3.13.0
func (EventSubscriptionOutput) ElementType() reflect.Type
func (EventSubscriptionOutput) ToEventSubscriptionOutput ¶ added in v3.13.0
func (o EventSubscriptionOutput) ToEventSubscriptionOutput() EventSubscriptionOutput
func (EventSubscriptionOutput) ToEventSubscriptionOutputWithContext ¶ added in v3.13.0
func (o EventSubscriptionOutput) ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput
type EventSubscriptionState ¶
type EventSubscriptionState struct { Arn pulumi.StringPtrInput CustomerAwsId pulumi.StringPtrInput // A boolean flag to enable/disable the subscription. Defaults to true. Enabled pulumi.BoolPtrInput // A list of event categories for a `sourceType` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories. EventCategories pulumi.StringArrayInput // The name of the Neptune event subscription. By default generated by this provider. Name pulumi.StringPtrInput // The name of the Neptune event subscription. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // The ARN of the SNS topic to send events to. SnsTopicArn pulumi.StringPtrInput // 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 `sourceType` must also be specified. SourceIds pulumi.StringArrayInput // 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 pulumi.StringPtrInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
func (EventSubscriptionState) ElementType ¶
func (EventSubscriptionState) ElementType() reflect.Type
type GetEngineVersionArgs ¶ added in v3.5.0
type GetEngineVersionArgs struct { // DB engine. (Default: `neptune`) Engine *string `pulumi:"engine"` // The name of a specific DB parameter group family. An example parameter group family is `neptune1`. ParameterGroupFamily *string `pulumi:"parameterGroupFamily"` // Ordered list of preferred engine versions. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine. PreferredVersions []string `pulumi:"preferredVersions"` // Version of the DB engine. For example, `1.0.1.0`, `1.0.2.2`, and `1.0.3.0`. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine. Version *string `pulumi:"version"` }
A collection of arguments for invoking getEngineVersion.
type GetEngineVersionResult ¶ added in v3.5.0
type GetEngineVersionResult struct { Engine *string `pulumi:"engine"` // The description of the database engine. EngineDescription string `pulumi:"engineDescription"` // Set of log types that the database engine has available for export to CloudWatch Logs. ExportableLogTypes []string `pulumi:"exportableLogTypes"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` ParameterGroupFamily string `pulumi:"parameterGroupFamily"` PreferredVersions []string `pulumi:"preferredVersions"` // Set of the time zones supported by this engine. SupportedTimezones []string `pulumi:"supportedTimezones"` // Indicates whether the engine version supports exporting the log types specified by `exportableLogTypes` to CloudWatch Logs. SupportsLogExportsToCloudwatch bool `pulumi:"supportsLogExportsToCloudwatch"` // Indicates whether the database engine version supports read replicas. SupportsReadReplica bool `pulumi:"supportsReadReplica"` // Set of engine versions that this database engine version can be upgraded to. ValidUpgradeTargets []string `pulumi:"validUpgradeTargets"` Version string `pulumi:"version"` // The description of the database engine version. VersionDescription string `pulumi:"versionDescription"` }
A collection of values returned by getEngineVersion.
func GetEngineVersion ¶ added in v3.5.0
func GetEngineVersion(ctx *pulumi.Context, args *GetEngineVersionArgs, opts ...pulumi.InvokeOption) (*GetEngineVersionResult, error)
Information about a Neptune engine version.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.GetEngineVersion(ctx, &neptune.GetEngineVersionArgs{ PreferredVersions: []string{ "1.0.3.0", "1.0.2.2", "1.0.2.1", }, }, nil) if err != nil { return err } return nil }) }
```
type GetOrderableDbInstanceArgs ¶ added in v3.3.0
type GetOrderableDbInstanceArgs struct { // DB engine. (Default: `neptune`) Engine *string `pulumi:"engine"` // Version of the DB engine. For example, `1.0.1.0`, `1.0.1.2`, `1.0.2.2`, and `1.0.3.0`. EngineVersion *string `pulumi:"engineVersion"` // DB instance class. Examples of classes are `db.r5.large`, `db.r5.xlarge`, `db.r4.large`, `db.r5.4xlarge`, `db.r5.12xlarge`, `db.r4.xlarge`, and `db.t3.medium`. InstanceClass *string `pulumi:"instanceClass"` // License model. (Default: `amazon-license`) LicenseModel *string `pulumi:"licenseModel"` // Ordered list of preferred Neptune DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. PreferredInstanceClasses []string `pulumi:"preferredInstanceClasses"` // Enable to show only VPC offerings. Vpc *bool `pulumi:"vpc"` }
A collection of arguments for invoking getOrderableDbInstance.
type GetOrderableDbInstanceResult ¶ added in v3.3.0
type GetOrderableDbInstanceResult struct { // Availability zones where the instance is available. AvailabilityZones []string `pulumi:"availabilityZones"` Engine *string `pulumi:"engine"` EngineVersion string `pulumi:"engineVersion"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` InstanceClass string `pulumi:"instanceClass"` LicenseModel *string `pulumi:"licenseModel"` // Maximum total provisioned IOPS for a DB instance. MaxIopsPerDbInstance int `pulumi:"maxIopsPerDbInstance"` // Maximum provisioned IOPS per GiB for a DB instance. MaxIopsPerGib float64 `pulumi:"maxIopsPerGib"` // Maximum storage size for a DB instance. MaxStorageSize int `pulumi:"maxStorageSize"` // Minimum total provisioned IOPS for a DB instance. MinIopsPerDbInstance int `pulumi:"minIopsPerDbInstance"` // Minimum provisioned IOPS per GiB for a DB instance. MinIopsPerGib float64 `pulumi:"minIopsPerGib"` // Minimum storage size for a DB instance. MinStorageSize int `pulumi:"minStorageSize"` // Whether a DB instance is Multi-AZ capable. MultiAzCapable bool `pulumi:"multiAzCapable"` PreferredInstanceClasses []string `pulumi:"preferredInstanceClasses"` // Whether a DB instance can have a read replica. ReadReplicaCapable bool `pulumi:"readReplicaCapable"` // The storage type for a DB instance. StorageType string `pulumi:"storageType"` // Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. SupportsEnhancedMonitoring bool `pulumi:"supportsEnhancedMonitoring"` // Whether a DB instance supports IAM database authentication. SupportsIamDatabaseAuthentication bool `pulumi:"supportsIamDatabaseAuthentication"` // Whether a DB instance supports provisioned IOPS. SupportsIops bool `pulumi:"supportsIops"` // Whether a DB instance supports Performance Insights. SupportsPerformanceInsights bool `pulumi:"supportsPerformanceInsights"` // Whether a DB instance supports encrypted storage. SupportsStorageEncryption bool `pulumi:"supportsStorageEncryption"` Vpc bool `pulumi:"vpc"` }
A collection of values returned by getOrderableDbInstance.
func GetOrderableDbInstance ¶ added in v3.3.0
func GetOrderableDbInstance(ctx *pulumi.Context, args *GetOrderableDbInstanceArgs, opts ...pulumi.InvokeOption) (*GetOrderableDbInstanceResult, error)
Information about Neptune orderable DB instances.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { opt0 := "1.0.3.0" _, err := neptune.GetOrderableDbInstance(ctx, &neptune.GetOrderableDbInstanceArgs{ EngineVersion: &opt0, PreferredInstanceClasses: []string{ "db.r5.large", "db.r4.large", "db.t3.medium", }, }, nil) if err != nil { return err } return nil }) }
```
type ParameterGroup ¶
type ParameterGroup struct { pulumi.CustomResourceState // The Neptune parameter group Amazon Resource Name (ARN). Arn pulumi.StringOutput `pulumi:"arn"` // The description of the Neptune parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrOutput `pulumi:"description"` // The family of the Neptune parameter group. Family pulumi.StringOutput `pulumi:"family"` // The name of the Neptune parameter. Name pulumi.StringOutput `pulumi:"name"` // A list of Neptune parameters to apply. Parameters ParameterGroupParameterArrayOutput `pulumi:"parameters"` // A map of tags to assign to the resource. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Manages a Neptune Parameter Group
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewParameterGroup(ctx, "example", &neptune.ParameterGroupArgs{ Family: pulumi.String("neptune1"), Parameters: neptune.ParameterGroupParameterArray{ &neptune.ParameterGroupParameterArgs{ Name: pulumi.String("neptune_query_timeout"), Value: pulumi.String("25"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Neptune Parameter Groups can be imported using the `name`, e.g.
```sh
$ pulumi import aws:neptune/parameterGroup:ParameterGroup some_pg some-pg
```
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.
func (ParameterGroup) ElementType ¶ added in v3.13.0
func (ParameterGroup) ElementType() reflect.Type
func (ParameterGroup) ToParameterGroupOutput ¶ added in v3.13.0
func (i ParameterGroup) ToParameterGroupOutput() ParameterGroupOutput
func (ParameterGroup) ToParameterGroupOutputWithContext ¶ added in v3.13.0
func (i ParameterGroup) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput
type ParameterGroupArgs ¶
type ParameterGroupArgs struct { // The description of the Neptune parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The family of the Neptune parameter group. Family pulumi.StringInput // The name of the Neptune parameter. Name pulumi.StringPtrInput // A list of Neptune parameters to apply. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
The set of arguments for constructing a ParameterGroup resource.
func (ParameterGroupArgs) ElementType ¶
func (ParameterGroupArgs) ElementType() reflect.Type
type ParameterGroupInput ¶ added in v3.13.0
type ParameterGroupInput interface { pulumi.Input ToParameterGroupOutput() ParameterGroupOutput ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput }
type ParameterGroupOutput ¶ added in v3.13.0
type ParameterGroupOutput struct {
*pulumi.OutputState
}
func (ParameterGroupOutput) ElementType ¶ added in v3.13.0
func (ParameterGroupOutput) ElementType() reflect.Type
func (ParameterGroupOutput) ToParameterGroupOutput ¶ added in v3.13.0
func (o ParameterGroupOutput) ToParameterGroupOutput() ParameterGroupOutput
func (ParameterGroupOutput) ToParameterGroupOutputWithContext ¶ added in v3.13.0
func (o ParameterGroupOutput) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput
type ParameterGroupParameter ¶
type ParameterGroupParameter struct { // The apply method of the Neptune parameter. Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`. ApplyMethod *string `pulumi:"applyMethod"` // The name of the Neptune parameter. Name string `pulumi:"name"` // The value of the Neptune parameter. Value string `pulumi:"value"` }
type ParameterGroupParameterArgs ¶
type ParameterGroupParameterArgs struct { // The apply method of the Neptune parameter. Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`. ApplyMethod pulumi.StringPtrInput `pulumi:"applyMethod"` // The name of the Neptune parameter. Name pulumi.StringInput `pulumi:"name"` // The value of the Neptune parameter. Value pulumi.StringInput `pulumi:"value"` }
func (ParameterGroupParameterArgs) ElementType ¶
func (ParameterGroupParameterArgs) ElementType() reflect.Type
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) ElementType() reflect.Type
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 }
ParameterGroupParameterArrayInput is an input type that accepts ParameterGroupParameterArray and ParameterGroupParameterArrayOutput values. You can construct a concrete instance of `ParameterGroupParameterArrayInput` via:
ParameterGroupParameterArray{ ParameterGroupParameterArgs{...} }
type ParameterGroupParameterArrayOutput ¶
type ParameterGroupParameterArrayOutput struct{ *pulumi.OutputState }
func (ParameterGroupParameterArrayOutput) ElementType ¶
func (ParameterGroupParameterArrayOutput) ElementType() reflect.Type
func (ParameterGroupParameterArrayOutput) Index ¶
func (o ParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ParameterGroupParameterOutput
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 }
ParameterGroupParameterInput is an input type that accepts ParameterGroupParameterArgs and ParameterGroupParameterOutput values. You can construct a concrete instance of `ParameterGroupParameterInput` via:
ParameterGroupParameterArgs{...}
type ParameterGroupParameterOutput ¶
type ParameterGroupParameterOutput struct{ *pulumi.OutputState }
func (ParameterGroupParameterOutput) ApplyMethod ¶
func (o ParameterGroupParameterOutput) ApplyMethod() pulumi.StringPtrOutput
The apply method of the Neptune parameter. Valid values are `immediate` and `pending-reboot`. Defaults to `pending-reboot`.
func (ParameterGroupParameterOutput) ElementType ¶
func (ParameterGroupParameterOutput) ElementType() reflect.Type
func (ParameterGroupParameterOutput) Name ¶
func (o ParameterGroupParameterOutput) Name() pulumi.StringOutput
The name of the Neptune parameter.
func (ParameterGroupParameterOutput) ToParameterGroupParameterOutput ¶
func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput
func (ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext ¶
func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput
func (ParameterGroupParameterOutput) Value ¶
func (o ParameterGroupParameterOutput) Value() pulumi.StringOutput
The value of the Neptune parameter.
type ParameterGroupState ¶
type ParameterGroupState struct { // The Neptune parameter group Amazon Resource Name (ARN). Arn pulumi.StringPtrInput // The description of the Neptune parameter group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The family of the Neptune parameter group. Family pulumi.StringPtrInput // The name of the Neptune parameter. Name pulumi.StringPtrInput // A list of Neptune parameters to apply. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
func (ParameterGroupState) ElementType ¶
func (ParameterGroupState) ElementType() reflect.Type
type SubnetGroup ¶
type SubnetGroup struct { pulumi.CustomResourceState // The ARN of the neptune subnet group. Arn pulumi.StringOutput `pulumi:"arn"` // The description of the neptune subnet group. Defaults to "Managed by Pulumi". Description pulumi.StringOutput `pulumi:"description"` // The name of the neptune subnet group. If omitted, this provider will assign a random, unique name. Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // A list of VPC subnet IDs. SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"` // A map of tags to assign to the resource. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Provides an Neptune subnet group resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewSubnetGroup(ctx, "_default", &neptune.SubnetGroupArgs{ SubnetIds: pulumi.StringArray{ pulumi.Any(aws_subnet.Frontend.Id), pulumi.Any(aws_subnet.Backend.Id), }, Tags: pulumi.StringMap{ "Name": pulumi.String("My neptune subnet group"), }, }) if err != nil { return err } return nil }) }
```
## Import
Neptune Subnet groups can be imported using the `name`, e.g.
```sh
$ pulumi import aws:neptune/subnetGroup:SubnetGroup default production-subnet-group
```
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.
func (SubnetGroup) ElementType ¶ added in v3.13.0
func (SubnetGroup) ElementType() reflect.Type
func (SubnetGroup) ToSubnetGroupOutput ¶ added in v3.13.0
func (i SubnetGroup) ToSubnetGroupOutput() SubnetGroupOutput
func (SubnetGroup) ToSubnetGroupOutputWithContext ¶ added in v3.13.0
func (i SubnetGroup) ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput
type SubnetGroupArgs ¶
type SubnetGroupArgs struct { // The description of the neptune subnet group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The name of the neptune subnet group. If omitted, this provider will assign a random, unique name. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of VPC subnet IDs. SubnetIds pulumi.StringArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
The set of arguments for constructing a SubnetGroup resource.
func (SubnetGroupArgs) ElementType ¶
func (SubnetGroupArgs) ElementType() reflect.Type
type SubnetGroupInput ¶ added in v3.13.0
type SubnetGroupInput interface { pulumi.Input ToSubnetGroupOutput() SubnetGroupOutput ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput }
type SubnetGroupOutput ¶ added in v3.13.0
type SubnetGroupOutput struct {
*pulumi.OutputState
}
func (SubnetGroupOutput) ElementType ¶ added in v3.13.0
func (SubnetGroupOutput) ElementType() reflect.Type
func (SubnetGroupOutput) ToSubnetGroupOutput ¶ added in v3.13.0
func (o SubnetGroupOutput) ToSubnetGroupOutput() SubnetGroupOutput
func (SubnetGroupOutput) ToSubnetGroupOutputWithContext ¶ added in v3.13.0
func (o SubnetGroupOutput) ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput
type SubnetGroupState ¶
type SubnetGroupState struct { // The ARN of the neptune subnet group. Arn pulumi.StringPtrInput // The description of the neptune subnet group. Defaults to "Managed by Pulumi". Description pulumi.StringPtrInput // The name of the neptune subnet group. If omitted, this provider will assign a random, unique name. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of VPC subnet IDs. SubnetIds pulumi.StringArrayInput // A map of tags to assign to the resource. Tags pulumi.StringMapInput }
func (SubnetGroupState) ElementType ¶
func (SubnetGroupState) ElementType() reflect.Type