Show / Hide Table of Contents

Class CfnDBInstancePropsMixin

The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

Inheritance
object
Mixin
CfnDBInstancePropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Neptune
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDBInstancePropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnDBInstancePropsMixin Inherits Mixin Implements IMixin
Remarks

Updating DB Instances

You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

    Deleting DB Instances

    If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
    

    When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

    We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
    

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

      CloudformationResource: AWS::Neptune::DBInstance

      Mixin: true

      ExampleMetadata: fixture=_generated

      Examples
      // The code below shows an example of how to instantiate this type.
                   // The values are placeholders you should change.
                   using Amazon.CDK.CfnPropertyMixins.AWS.Neptune;
                   using Amazon.CDK;
      
                   IMergeStrategy mergeStrategy;
      
                   var cfnDBInstancePropsMixin = new CfnDBInstancePropsMixin(new CfnDBInstanceMixinProps {
                       AllowMajorVersionUpgrade = false,
                       AutoMinorVersionUpgrade = false,
                       AvailabilityZone = "availabilityZone",
                       DbClusterIdentifier = "dbClusterIdentifier",
                       DbInstanceClass = "dbInstanceClass",
                       DbInstanceIdentifier = "dbInstanceIdentifier",
                       DbParameterGroupName = "dbParameterGroupName",
                       DbSnapshotIdentifier = "dbSnapshotIdentifier",
                       DbSubnetGroupName = "dbSubnetGroupName",
                       PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                       PubliclyAccessible = false,
                       Tags = new [] { new CfnTag {
                           Key = "key",
                           Value = "value"
                       } }
                   }, new CfnPropertyMixinOptions {
                       Strategy = mergeStrategy
                   });

      Synopsis

      Constructors

      CfnDBInstancePropsMixin(ICfnDBInstanceMixinProps, ICfnPropertyMixinOptions?)

      Create a mixin to apply properties to AWS::Neptune::DBInstance.

      Properties

      CFN_PROPERTY_KEYS

      The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

      Props

      The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

      Strategy

      The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

      Methods

      ApplyTo(IConstruct)

      Apply the mixin properties to the construct.

      Supports(IConstruct)

      Check if this mixin supports the given construct.

      Constructors

      CfnDBInstancePropsMixin(ICfnDBInstanceMixinProps, ICfnPropertyMixinOptions?)

      Create a mixin to apply properties to AWS::Neptune::DBInstance.

      public CfnDBInstancePropsMixin(ICfnDBInstanceMixinProps props, ICfnPropertyMixinOptions? options = null)
      Parameters
      props ICfnDBInstanceMixinProps

      L1 properties to apply.

      options ICfnPropertyMixinOptions

      Mixin options.

      Remarks

      Updating DB Instances

      You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

        Deleting DB Instances

        If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
        

        When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

        We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
        

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

          CloudformationResource: AWS::Neptune::DBInstance

          Mixin: true

          ExampleMetadata: fixture=_generated

          Properties

          CFN_PROPERTY_KEYS

          The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

          protected static string[] CFN_PROPERTY_KEYS { get; }
          Property Value

          string[]

          Remarks

          Updating DB Instances

          You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

            Deleting DB Instances

            If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
            

            When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

            We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
            

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

              CloudformationResource: AWS::Neptune::DBInstance

              Mixin: true

              ExampleMetadata: fixture=_generated

              Examples
              // The code below shows an example of how to instantiate this type.
                           // The values are placeholders you should change.
                           using Amazon.CDK.CfnPropertyMixins.AWS.Neptune;
                           using Amazon.CDK;
              
                           IMergeStrategy mergeStrategy;
              
                           var cfnDBInstancePropsMixin = new CfnDBInstancePropsMixin(new CfnDBInstanceMixinProps {
                               AllowMajorVersionUpgrade = false,
                               AutoMinorVersionUpgrade = false,
                               AvailabilityZone = "availabilityZone",
                               DbClusterIdentifier = "dbClusterIdentifier",
                               DbInstanceClass = "dbInstanceClass",
                               DbInstanceIdentifier = "dbInstanceIdentifier",
                               DbParameterGroupName = "dbParameterGroupName",
                               DbSnapshotIdentifier = "dbSnapshotIdentifier",
                               DbSubnetGroupName = "dbSubnetGroupName",
                               PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                               PubliclyAccessible = false,
                               Tags = new [] { new CfnTag {
                                   Key = "key",
                                   Value = "value"
                               } }
                           }, new CfnPropertyMixinOptions {
                               Strategy = mergeStrategy
                           });

              Props

              The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

              protected virtual ICfnDBInstanceMixinProps Props { get; }
              Property Value

              ICfnDBInstanceMixinProps

              Remarks

              Updating DB Instances

              You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

                Deleting DB Instances

                If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
                

                When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

                We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
                

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

                  CloudformationResource: AWS::Neptune::DBInstance

                  Mixin: true

                  ExampleMetadata: fixture=_generated

                  Examples
                  // The code below shows an example of how to instantiate this type.
                               // The values are placeholders you should change.
                               using Amazon.CDK.CfnPropertyMixins.AWS.Neptune;
                               using Amazon.CDK;
                  
                               IMergeStrategy mergeStrategy;
                  
                               var cfnDBInstancePropsMixin = new CfnDBInstancePropsMixin(new CfnDBInstanceMixinProps {
                                   AllowMajorVersionUpgrade = false,
                                   AutoMinorVersionUpgrade = false,
                                   AvailabilityZone = "availabilityZone",
                                   DbClusterIdentifier = "dbClusterIdentifier",
                                   DbInstanceClass = "dbInstanceClass",
                                   DbInstanceIdentifier = "dbInstanceIdentifier",
                                   DbParameterGroupName = "dbParameterGroupName",
                                   DbSnapshotIdentifier = "dbSnapshotIdentifier",
                                   DbSubnetGroupName = "dbSubnetGroupName",
                                   PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                                   PubliclyAccessible = false,
                                   Tags = new [] { new CfnTag {
                                       Key = "key",
                                       Value = "value"
                                   } }
                               }, new CfnPropertyMixinOptions {
                                   Strategy = mergeStrategy
                               });

                  Strategy

                  The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

                  protected virtual IMergeStrategy Strategy { get; }
                  Property Value

                  IMergeStrategy

                  Remarks

                  Updating DB Instances

                  You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

                    Deleting DB Instances

                    If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
                    

                    When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

                    We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
                    

                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

                      CloudformationResource: AWS::Neptune::DBInstance

                      Mixin: true

                      ExampleMetadata: fixture=_generated

                      Examples
                      // The code below shows an example of how to instantiate this type.
                                   // The values are placeholders you should change.
                                   using Amazon.CDK.CfnPropertyMixins.AWS.Neptune;
                                   using Amazon.CDK;
                      
                                   IMergeStrategy mergeStrategy;
                      
                                   var cfnDBInstancePropsMixin = new CfnDBInstancePropsMixin(new CfnDBInstanceMixinProps {
                                       AllowMajorVersionUpgrade = false,
                                       AutoMinorVersionUpgrade = false,
                                       AvailabilityZone = "availabilityZone",
                                       DbClusterIdentifier = "dbClusterIdentifier",
                                       DbInstanceClass = "dbInstanceClass",
                                       DbInstanceIdentifier = "dbInstanceIdentifier",
                                       DbParameterGroupName = "dbParameterGroupName",
                                       DbSnapshotIdentifier = "dbSnapshotIdentifier",
                                       DbSubnetGroupName = "dbSubnetGroupName",
                                       PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                                       PubliclyAccessible = false,
                                       Tags = new [] { new CfnTag {
                                           Key = "key",
                                           Value = "value"
                                       } }
                                   }, new CfnPropertyMixinOptions {
                                       Strategy = mergeStrategy
                                   });

                      Methods

                      ApplyTo(IConstruct)

                      Apply the mixin properties to the construct.

                      public override void ApplyTo(IConstruct construct)
                      Parameters
                      construct IConstruct
                      Overrides
                      Mixin.ApplyTo(IConstruct)
                      Remarks

                      Updating DB Instances

                      You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

                        Deleting DB Instances

                        If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
                        

                        When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

                        We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
                        

                          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

                          CloudformationResource: AWS::Neptune::DBInstance

                          Mixin: true

                          ExampleMetadata: fixture=_generated

                          Supports(IConstruct)

                          Check if this mixin supports the given construct.

                          public override bool Supports(IConstruct construct)
                          Parameters
                          construct IConstruct
                          Returns

                          bool

                          Overrides
                          Mixin.Supports(IConstruct)
                          Remarks

                          Updating DB Instances

                          You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

                            Deleting DB Instances

                            If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
                            

                            When properties labeled Update requires: Replacement are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

                            We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
                            

                              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html

                              CloudformationResource: AWS::Neptune::DBInstance

                              Mixin: true

                              ExampleMetadata: fixture=_generated

                              Implements

                              Constructs.IMixin
                              Back to top Generated by DocFX