Documentation ¶
Index ¶
- type Cluster
- type ClusterArgs
- type ClusterArray
- type ClusterArrayInput
- type ClusterArrayOutput
- type ClusterEndpoint
- type ClusterEndpointArgs
- type ClusterEndpointArray
- type ClusterEndpointArrayInput
- type ClusterEndpointArrayOutput
- func (ClusterEndpointArrayOutput) ElementType() reflect.Type
- func (o ClusterEndpointArrayOutput) Index(i pulumi.IntInput) ClusterEndpointOutput
- func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput
- func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterEndpointArrayOutput
- type ClusterEndpointInput
- type ClusterEndpointMap
- type ClusterEndpointMapInput
- type ClusterEndpointMapOutput
- func (ClusterEndpointMapOutput) ElementType() reflect.Type
- func (o ClusterEndpointMapOutput) MapIndex(k pulumi.StringInput) ClusterEndpointOutput
- func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutput() ClusterEndpointMapOutput
- func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutputWithContext(ctx context.Context) ClusterEndpointMapOutput
- type ClusterEndpointOutput
- func (o ClusterEndpointOutput) Arn() pulumi.StringOutput
- func (o ClusterEndpointOutput) ClusterEndpointIdentifier() pulumi.StringOutput
- func (o ClusterEndpointOutput) ClusterIdentifier() pulumi.StringOutput
- func (ClusterEndpointOutput) ElementType() reflect.Type
- func (o ClusterEndpointOutput) Endpoint() pulumi.StringOutput
- func (o ClusterEndpointOutput) EndpointType() pulumi.StringOutput
- func (o ClusterEndpointOutput) ExcludedMembers() pulumi.StringArrayOutput
- func (o ClusterEndpointOutput) StaticMembers() pulumi.StringArrayOutput
- func (o ClusterEndpointOutput) Tags() pulumi.StringMapOutput
- func (o ClusterEndpointOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o ClusterEndpointOutput) ToClusterEndpointOutput() ClusterEndpointOutput
- func (o ClusterEndpointOutput) ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput
- type ClusterEndpointState
- type ClusterInput
- type ClusterInstance
- type ClusterInstanceArgs
- type ClusterInstanceArray
- type ClusterInstanceArrayInput
- type ClusterInstanceArrayOutput
- func (ClusterInstanceArrayOutput) ElementType() reflect.Type
- func (o ClusterInstanceArrayOutput) Index(i pulumi.IntInput) ClusterInstanceOutput
- func (o ClusterInstanceArrayOutput) ToClusterInstanceArrayOutput() ClusterInstanceArrayOutput
- func (o ClusterInstanceArrayOutput) ToClusterInstanceArrayOutputWithContext(ctx context.Context) ClusterInstanceArrayOutput
- type ClusterInstanceInput
- type ClusterInstanceMap
- type ClusterInstanceMapInput
- type ClusterInstanceMapOutput
- func (ClusterInstanceMapOutput) ElementType() reflect.Type
- func (o ClusterInstanceMapOutput) MapIndex(k pulumi.StringInput) ClusterInstanceOutput
- func (o ClusterInstanceMapOutput) ToClusterInstanceMapOutput() ClusterInstanceMapOutput
- func (o ClusterInstanceMapOutput) ToClusterInstanceMapOutputWithContext(ctx context.Context) ClusterInstanceMapOutput
- type ClusterInstanceOutput
- func (o ClusterInstanceOutput) Address() pulumi.StringOutput
- func (o ClusterInstanceOutput) ApplyImmediately() pulumi.BoolOutput
- func (o ClusterInstanceOutput) Arn() pulumi.StringOutput
- func (o ClusterInstanceOutput) AutoMinorVersionUpgrade() pulumi.BoolPtrOutput
- func (o ClusterInstanceOutput) AvailabilityZone() pulumi.StringOutput
- func (o ClusterInstanceOutput) ClusterIdentifier() pulumi.StringOutput
- func (o ClusterInstanceOutput) DbiResourceId() pulumi.StringOutput
- func (ClusterInstanceOutput) ElementType() reflect.Type
- func (o ClusterInstanceOutput) Endpoint() pulumi.StringOutput
- func (o ClusterInstanceOutput) Engine() pulumi.StringPtrOutput
- func (o ClusterInstanceOutput) EngineVersion() pulumi.StringOutput
- func (o ClusterInstanceOutput) Identifier() pulumi.StringOutput
- func (o ClusterInstanceOutput) IdentifierPrefix() pulumi.StringOutput
- func (o ClusterInstanceOutput) InstanceClass() pulumi.StringOutput
- func (o ClusterInstanceOutput) KmsKeyArn() pulumi.StringOutput
- func (o ClusterInstanceOutput) NeptuneParameterGroupName() pulumi.StringOutput
- func (o ClusterInstanceOutput) NeptuneSubnetGroupName() pulumi.StringOutput
- func (o ClusterInstanceOutput) Port() pulumi.IntPtrOutput
- func (o ClusterInstanceOutput) PreferredBackupWindow() pulumi.StringOutput
- func (o ClusterInstanceOutput) PreferredMaintenanceWindow() pulumi.StringOutput
- func (o ClusterInstanceOutput) PromotionTier() pulumi.IntPtrOutput
- func (o ClusterInstanceOutput) PubliclyAccessible() pulumi.BoolPtrOutput
- func (o ClusterInstanceOutput) SkipFinalSnapshot() pulumi.BoolPtrOutput
- func (o ClusterInstanceOutput) StorageEncrypted() pulumi.BoolOutput
- func (o ClusterInstanceOutput) StorageType() pulumi.StringOutput
- func (o ClusterInstanceOutput) Tags() pulumi.StringMapOutput
- func (o ClusterInstanceOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o ClusterInstanceOutput) ToClusterInstanceOutput() ClusterInstanceOutput
- func (o ClusterInstanceOutput) ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput
- func (o ClusterInstanceOutput) Writer() pulumi.BoolOutput
- type ClusterInstanceState
- type ClusterMap
- type ClusterMapInput
- type ClusterMapOutput
- type ClusterOutput
- func (o ClusterOutput) AllowMajorVersionUpgrade() pulumi.BoolOutput
- func (o ClusterOutput) ApplyImmediately() pulumi.BoolOutput
- func (o ClusterOutput) Arn() pulumi.StringOutput
- func (o ClusterOutput) AvailabilityZones() pulumi.StringArrayOutput
- func (o ClusterOutput) BackupRetentionPeriod() pulumi.IntPtrOutput
- func (o ClusterOutput) ClusterIdentifier() pulumi.StringOutput
- func (o ClusterOutput) ClusterIdentifierPrefix() pulumi.StringOutput
- func (o ClusterOutput) ClusterMembers() pulumi.StringArrayOutput
- func (o ClusterOutput) ClusterResourceId() pulumi.StringOutput
- func (o ClusterOutput) CopyTagsToSnapshot() pulumi.BoolPtrOutput
- func (o ClusterOutput) DeletionProtection() pulumi.BoolPtrOutput
- func (ClusterOutput) ElementType() reflect.Type
- func (o ClusterOutput) EnableCloudwatchLogsExports() pulumi.StringArrayOutput
- func (o ClusterOutput) Endpoint() pulumi.StringOutput
- func (o ClusterOutput) Engine() pulumi.StringPtrOutput
- func (o ClusterOutput) EngineVersion() pulumi.StringOutput
- func (o ClusterOutput) FinalSnapshotIdentifier() pulumi.StringPtrOutput
- func (o ClusterOutput) GlobalClusterIdentifier() pulumi.StringPtrOutput
- func (o ClusterOutput) HostedZoneId() pulumi.StringOutput
- func (o ClusterOutput) IamDatabaseAuthenticationEnabled() pulumi.BoolPtrOutput
- func (o ClusterOutput) IamRoles() pulumi.StringArrayOutput
- func (o ClusterOutput) KmsKeyArn() pulumi.StringOutput
- func (o ClusterOutput) NeptuneClusterParameterGroupName() pulumi.StringOutput
- func (o ClusterOutput) NeptuneInstanceParameterGroupName() pulumi.StringPtrOutput
- func (o ClusterOutput) NeptuneSubnetGroupName() pulumi.StringOutput
- func (o ClusterOutput) Port() pulumi.IntPtrOutput
- func (o ClusterOutput) PreferredBackupWindow() pulumi.StringOutput
- func (o ClusterOutput) PreferredMaintenanceWindow() pulumi.StringOutput
- func (o ClusterOutput) ReaderEndpoint() pulumi.StringOutput
- func (o ClusterOutput) ReplicationSourceIdentifier() pulumi.StringPtrOutput
- func (o ClusterOutput) ServerlessV2ScalingConfiguration() ClusterServerlessV2ScalingConfigurationPtrOutput
- func (o ClusterOutput) SkipFinalSnapshot() pulumi.BoolPtrOutput
- func (o ClusterOutput) SnapshotIdentifier() pulumi.StringPtrOutput
- func (o ClusterOutput) StorageEncrypted() pulumi.BoolPtrOutput
- func (o ClusterOutput) StorageType() pulumi.StringOutput
- func (o ClusterOutput) Tags() pulumi.StringMapOutput
- func (o ClusterOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o ClusterOutput) ToClusterOutput() ClusterOutput
- func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
- func (o ClusterOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput
- type ClusterParameterGroup
- type ClusterParameterGroupArgs
- type ClusterParameterGroupArray
- func (ClusterParameterGroupArray) ElementType() reflect.Type
- func (i ClusterParameterGroupArray) ToClusterParameterGroupArrayOutput() ClusterParameterGroupArrayOutput
- func (i ClusterParameterGroupArray) ToClusterParameterGroupArrayOutputWithContext(ctx context.Context) ClusterParameterGroupArrayOutput
- type ClusterParameterGroupArrayInput
- type ClusterParameterGroupArrayOutput
- func (ClusterParameterGroupArrayOutput) ElementType() reflect.Type
- func (o ClusterParameterGroupArrayOutput) Index(i pulumi.IntInput) ClusterParameterGroupOutput
- func (o ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutput() ClusterParameterGroupArrayOutput
- func (o ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutputWithContext(ctx context.Context) ClusterParameterGroupArrayOutput
- type ClusterParameterGroupInput
- type ClusterParameterGroupMap
- type ClusterParameterGroupMapInput
- type ClusterParameterGroupMapOutput
- func (ClusterParameterGroupMapOutput) ElementType() reflect.Type
- func (o ClusterParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ClusterParameterGroupOutput
- func (o ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutput() ClusterParameterGroupMapOutput
- func (o ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutputWithContext(ctx context.Context) ClusterParameterGroupMapOutput
- type ClusterParameterGroupOutput
- func (o ClusterParameterGroupOutput) Arn() pulumi.StringOutput
- func (o ClusterParameterGroupOutput) Description() pulumi.StringPtrOutput
- func (ClusterParameterGroupOutput) ElementType() reflect.Type
- func (o ClusterParameterGroupOutput) Family() pulumi.StringOutput
- func (o ClusterParameterGroupOutput) Name() pulumi.StringOutput
- func (o ClusterParameterGroupOutput) NamePrefix() pulumi.StringOutput
- func (o ClusterParameterGroupOutput) Parameters() ClusterParameterGroupParameterArrayOutput
- func (o ClusterParameterGroupOutput) Tags() pulumi.StringMapOutput
- func (o ClusterParameterGroupOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o ClusterParameterGroupOutput) ToClusterParameterGroupOutput() ClusterParameterGroupOutput
- func (o ClusterParameterGroupOutput) ToClusterParameterGroupOutputWithContext(ctx context.Context) 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 ClusterServerlessV2ScalingConfiguration
- type ClusterServerlessV2ScalingConfigurationArgs
- func (ClusterServerlessV2ScalingConfigurationArgs) ElementType() reflect.Type
- func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutput() ClusterServerlessV2ScalingConfigurationOutput
- func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationOutput
- func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
- func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
- type ClusterServerlessV2ScalingConfigurationInput
- type ClusterServerlessV2ScalingConfigurationOutput
- func (ClusterServerlessV2ScalingConfigurationOutput) ElementType() reflect.Type
- func (o ClusterServerlessV2ScalingConfigurationOutput) MaxCapacity() pulumi.Float64PtrOutput
- func (o ClusterServerlessV2ScalingConfigurationOutput) MinCapacity() pulumi.Float64PtrOutput
- func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutput() ClusterServerlessV2ScalingConfigurationOutput
- func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationOutput
- func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
- func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
- type ClusterServerlessV2ScalingConfigurationPtrInput
- type ClusterServerlessV2ScalingConfigurationPtrOutput
- func (o ClusterServerlessV2ScalingConfigurationPtrOutput) Elem() ClusterServerlessV2ScalingConfigurationOutput
- func (ClusterServerlessV2ScalingConfigurationPtrOutput) ElementType() reflect.Type
- func (o ClusterServerlessV2ScalingConfigurationPtrOutput) MaxCapacity() pulumi.Float64PtrOutput
- func (o ClusterServerlessV2ScalingConfigurationPtrOutput) MinCapacity() pulumi.Float64PtrOutput
- func (o ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
- func (o ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
- type ClusterSnapshot
- type ClusterSnapshotArgs
- type ClusterSnapshotArray
- type ClusterSnapshotArrayInput
- type ClusterSnapshotArrayOutput
- func (ClusterSnapshotArrayOutput) ElementType() reflect.Type
- func (o ClusterSnapshotArrayOutput) Index(i pulumi.IntInput) ClusterSnapshotOutput
- func (o ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutput() ClusterSnapshotArrayOutput
- func (o ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutputWithContext(ctx context.Context) ClusterSnapshotArrayOutput
- type ClusterSnapshotInput
- type ClusterSnapshotMap
- type ClusterSnapshotMapInput
- type ClusterSnapshotMapOutput
- func (ClusterSnapshotMapOutput) ElementType() reflect.Type
- func (o ClusterSnapshotMapOutput) MapIndex(k pulumi.StringInput) ClusterSnapshotOutput
- func (o ClusterSnapshotMapOutput) ToClusterSnapshotMapOutput() ClusterSnapshotMapOutput
- func (o ClusterSnapshotMapOutput) ToClusterSnapshotMapOutputWithContext(ctx context.Context) ClusterSnapshotMapOutput
- type ClusterSnapshotOutput
- func (o ClusterSnapshotOutput) AllocatedStorage() pulumi.IntOutput
- func (o ClusterSnapshotOutput) AvailabilityZones() pulumi.StringArrayOutput
- func (o ClusterSnapshotOutput) DbClusterIdentifier() pulumi.StringOutput
- func (o ClusterSnapshotOutput) DbClusterSnapshotArn() pulumi.StringOutput
- func (o ClusterSnapshotOutput) DbClusterSnapshotIdentifier() pulumi.StringOutput
- func (ClusterSnapshotOutput) ElementType() reflect.Type
- func (o ClusterSnapshotOutput) Engine() pulumi.StringOutput
- func (o ClusterSnapshotOutput) EngineVersion() pulumi.StringOutput
- func (o ClusterSnapshotOutput) KmsKeyId() pulumi.StringOutput
- func (o ClusterSnapshotOutput) LicenseModel() pulumi.StringOutput
- func (o ClusterSnapshotOutput) Port() pulumi.IntOutput
- func (o ClusterSnapshotOutput) SnapshotType() pulumi.StringOutput
- func (o ClusterSnapshotOutput) SourceDbClusterSnapshotArn() pulumi.StringOutput
- func (o ClusterSnapshotOutput) Status() pulumi.StringOutput
- func (o ClusterSnapshotOutput) StorageEncrypted() pulumi.BoolOutput
- func (o ClusterSnapshotOutput) ToClusterSnapshotOutput() ClusterSnapshotOutput
- func (o ClusterSnapshotOutput) ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput
- func (o ClusterSnapshotOutput) VpcId() pulumi.StringOutput
- type ClusterSnapshotState
- type ClusterState
- type EventSubscription
- type EventSubscriptionArgs
- type EventSubscriptionArray
- type EventSubscriptionArrayInput
- type EventSubscriptionArrayOutput
- func (EventSubscriptionArrayOutput) ElementType() reflect.Type
- func (o EventSubscriptionArrayOutput) Index(i pulumi.IntInput) EventSubscriptionOutput
- func (o EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutput() EventSubscriptionArrayOutput
- func (o EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutputWithContext(ctx context.Context) EventSubscriptionArrayOutput
- type EventSubscriptionInput
- type EventSubscriptionMap
- type EventSubscriptionMapInput
- type EventSubscriptionMapOutput
- func (EventSubscriptionMapOutput) ElementType() reflect.Type
- func (o EventSubscriptionMapOutput) MapIndex(k pulumi.StringInput) EventSubscriptionOutput
- func (o EventSubscriptionMapOutput) ToEventSubscriptionMapOutput() EventSubscriptionMapOutput
- func (o EventSubscriptionMapOutput) ToEventSubscriptionMapOutputWithContext(ctx context.Context) EventSubscriptionMapOutput
- type EventSubscriptionOutput
- func (o EventSubscriptionOutput) Arn() pulumi.StringOutput
- func (o EventSubscriptionOutput) CustomerAwsId() pulumi.StringOutput
- func (EventSubscriptionOutput) ElementType() reflect.Type
- func (o EventSubscriptionOutput) Enabled() pulumi.BoolPtrOutput
- func (o EventSubscriptionOutput) EventCategories() pulumi.StringArrayOutput
- func (o EventSubscriptionOutput) Name() pulumi.StringOutput
- func (o EventSubscriptionOutput) NamePrefix() pulumi.StringOutput
- func (o EventSubscriptionOutput) SnsTopicArn() pulumi.StringOutput
- func (o EventSubscriptionOutput) SourceIds() pulumi.StringArrayOutput
- func (o EventSubscriptionOutput) SourceType() pulumi.StringPtrOutput
- func (o EventSubscriptionOutput) Tags() pulumi.StringMapOutput
- func (o EventSubscriptionOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o EventSubscriptionOutput) ToEventSubscriptionOutput() EventSubscriptionOutput
- func (o EventSubscriptionOutput) ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput
- type EventSubscriptionState
- type GetEngineVersionArgs
- type GetEngineVersionOutputArgs
- type GetEngineVersionResult
- type GetEngineVersionResultOutput
- func (GetEngineVersionResultOutput) ElementType() reflect.Type
- func (o GetEngineVersionResultOutput) Engine() pulumi.StringPtrOutput
- func (o GetEngineVersionResultOutput) EngineDescription() pulumi.StringOutput
- func (o GetEngineVersionResultOutput) ExportableLogTypes() pulumi.StringArrayOutput
- func (o GetEngineVersionResultOutput) Id() pulumi.StringOutput
- func (o GetEngineVersionResultOutput) ParameterGroupFamily() pulumi.StringOutput
- func (o GetEngineVersionResultOutput) PreferredVersions() pulumi.StringArrayOutput
- func (o GetEngineVersionResultOutput) SupportedTimezones() pulumi.StringArrayOutput
- func (o GetEngineVersionResultOutput) SupportsLogExportsToCloudwatch() pulumi.BoolOutput
- func (o GetEngineVersionResultOutput) SupportsReadReplica() pulumi.BoolOutput
- func (o GetEngineVersionResultOutput) ToGetEngineVersionResultOutput() GetEngineVersionResultOutput
- func (o GetEngineVersionResultOutput) ToGetEngineVersionResultOutputWithContext(ctx context.Context) GetEngineVersionResultOutput
- func (o GetEngineVersionResultOutput) ValidUpgradeTargets() pulumi.StringArrayOutput
- func (o GetEngineVersionResultOutput) Version() pulumi.StringOutput
- func (o GetEngineVersionResultOutput) VersionDescription() pulumi.StringOutput
- type GetOrderableDbInstanceArgs
- type GetOrderableDbInstanceOutputArgs
- type GetOrderableDbInstanceResult
- type GetOrderableDbInstanceResultOutput
- func (o GetOrderableDbInstanceResultOutput) AvailabilityZones() pulumi.StringArrayOutput
- func (GetOrderableDbInstanceResultOutput) ElementType() reflect.Type
- func (o GetOrderableDbInstanceResultOutput) Engine() pulumi.StringPtrOutput
- func (o GetOrderableDbInstanceResultOutput) EngineVersion() pulumi.StringOutput
- func (o GetOrderableDbInstanceResultOutput) Id() pulumi.StringOutput
- func (o GetOrderableDbInstanceResultOutput) InstanceClass() pulumi.StringOutput
- func (o GetOrderableDbInstanceResultOutput) LicenseModel() pulumi.StringPtrOutput
- func (o GetOrderableDbInstanceResultOutput) MaxIopsPerDbInstance() pulumi.IntOutput
- func (o GetOrderableDbInstanceResultOutput) MaxIopsPerGib() pulumi.Float64Output
- func (o GetOrderableDbInstanceResultOutput) MaxStorageSize() pulumi.IntOutput
- func (o GetOrderableDbInstanceResultOutput) MinIopsPerDbInstance() pulumi.IntOutput
- func (o GetOrderableDbInstanceResultOutput) MinIopsPerGib() pulumi.Float64Output
- func (o GetOrderableDbInstanceResultOutput) MinStorageSize() pulumi.IntOutput
- func (o GetOrderableDbInstanceResultOutput) MultiAzCapable() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) PreferredInstanceClasses() pulumi.StringArrayOutput
- func (o GetOrderableDbInstanceResultOutput) ReadReplicaCapable() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) StorageType() pulumi.StringOutput
- func (o GetOrderableDbInstanceResultOutput) SupportsEnhancedMonitoring() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) SupportsIamDatabaseAuthentication() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) SupportsIops() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) SupportsPerformanceInsights() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) SupportsStorageEncryption() pulumi.BoolOutput
- func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutput() GetOrderableDbInstanceResultOutput
- func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutputWithContext(ctx context.Context) GetOrderableDbInstanceResultOutput
- func (o GetOrderableDbInstanceResultOutput) Vpc() pulumi.BoolOutput
- type GlobalCluster
- type GlobalClusterArgs
- type GlobalClusterArray
- type GlobalClusterArrayInput
- type GlobalClusterArrayOutput
- func (GlobalClusterArrayOutput) ElementType() reflect.Type
- func (o GlobalClusterArrayOutput) Index(i pulumi.IntInput) GlobalClusterOutput
- func (o GlobalClusterArrayOutput) ToGlobalClusterArrayOutput() GlobalClusterArrayOutput
- func (o GlobalClusterArrayOutput) ToGlobalClusterArrayOutputWithContext(ctx context.Context) GlobalClusterArrayOutput
- type GlobalClusterGlobalClusterMember
- type GlobalClusterGlobalClusterMemberArgs
- func (GlobalClusterGlobalClusterMemberArgs) ElementType() reflect.Type
- func (i GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutput() GlobalClusterGlobalClusterMemberOutput
- func (i GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberOutput
- type GlobalClusterGlobalClusterMemberArray
- func (GlobalClusterGlobalClusterMemberArray) ElementType() reflect.Type
- func (i GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutput() GlobalClusterGlobalClusterMemberArrayOutput
- func (i GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberArrayOutput
- type GlobalClusterGlobalClusterMemberArrayInput
- type GlobalClusterGlobalClusterMemberArrayOutput
- func (GlobalClusterGlobalClusterMemberArrayOutput) ElementType() reflect.Type
- func (o GlobalClusterGlobalClusterMemberArrayOutput) Index(i pulumi.IntInput) GlobalClusterGlobalClusterMemberOutput
- func (o GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutput() GlobalClusterGlobalClusterMemberArrayOutput
- func (o GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberArrayOutput
- type GlobalClusterGlobalClusterMemberInput
- type GlobalClusterGlobalClusterMemberOutput
- func (o GlobalClusterGlobalClusterMemberOutput) DbClusterArn() pulumi.StringPtrOutput
- func (GlobalClusterGlobalClusterMemberOutput) ElementType() reflect.Type
- func (o GlobalClusterGlobalClusterMemberOutput) IsWriter() pulumi.BoolPtrOutput
- func (o GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutput() GlobalClusterGlobalClusterMemberOutput
- func (o GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberOutput
- type GlobalClusterInput
- type GlobalClusterMap
- type GlobalClusterMapInput
- type GlobalClusterMapOutput
- func (GlobalClusterMapOutput) ElementType() reflect.Type
- func (o GlobalClusterMapOutput) MapIndex(k pulumi.StringInput) GlobalClusterOutput
- func (o GlobalClusterMapOutput) ToGlobalClusterMapOutput() GlobalClusterMapOutput
- func (o GlobalClusterMapOutput) ToGlobalClusterMapOutputWithContext(ctx context.Context) GlobalClusterMapOutput
- type GlobalClusterOutput
- func (o GlobalClusterOutput) Arn() pulumi.StringOutput
- func (o GlobalClusterOutput) DeletionProtection() pulumi.BoolPtrOutput
- func (GlobalClusterOutput) ElementType() reflect.Type
- func (o GlobalClusterOutput) Engine() pulumi.StringOutput
- func (o GlobalClusterOutput) EngineVersion() pulumi.StringOutput
- func (o GlobalClusterOutput) GlobalClusterIdentifier() pulumi.StringOutput
- func (o GlobalClusterOutput) GlobalClusterMembers() GlobalClusterGlobalClusterMemberArrayOutput
- func (o GlobalClusterOutput) GlobalClusterResourceId() pulumi.StringOutput
- func (o GlobalClusterOutput) SourceDbClusterIdentifier() pulumi.StringOutput
- func (o GlobalClusterOutput) Status() pulumi.StringOutput
- func (o GlobalClusterOutput) StorageEncrypted() pulumi.BoolOutput
- func (o GlobalClusterOutput) ToGlobalClusterOutput() GlobalClusterOutput
- func (o GlobalClusterOutput) ToGlobalClusterOutputWithContext(ctx context.Context) GlobalClusterOutput
- type GlobalClusterState
- type ParameterGroup
- type ParameterGroupArgs
- type ParameterGroupArray
- type ParameterGroupArrayInput
- type ParameterGroupArrayOutput
- func (ParameterGroupArrayOutput) ElementType() reflect.Type
- func (o ParameterGroupArrayOutput) Index(i pulumi.IntInput) ParameterGroupOutput
- func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
- func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
- type ParameterGroupInput
- type ParameterGroupMap
- type ParameterGroupMapInput
- type ParameterGroupMapOutput
- func (ParameterGroupMapOutput) ElementType() reflect.Type
- func (o ParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ParameterGroupOutput
- func (o ParameterGroupMapOutput) ToParameterGroupMapOutput() ParameterGroupMapOutput
- func (o ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
- type ParameterGroupOutput
- func (o ParameterGroupOutput) Arn() pulumi.StringOutput
- func (o ParameterGroupOutput) Description() pulumi.StringPtrOutput
- func (ParameterGroupOutput) ElementType() reflect.Type
- func (o ParameterGroupOutput) Family() pulumi.StringOutput
- func (o ParameterGroupOutput) Name() pulumi.StringOutput
- func (o ParameterGroupOutput) NamePrefix() pulumi.StringOutput
- func (o ParameterGroupOutput) Parameters() ParameterGroupParameterArrayOutput
- func (o ParameterGroupOutput) Tags() pulumi.StringMapOutput
- func (o ParameterGroupOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o ParameterGroupOutput) ToParameterGroupOutput() ParameterGroupOutput
- func (o ParameterGroupOutput) ToParameterGroupOutputWithContext(ctx context.Context) 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 SubnetGroupArray
- type SubnetGroupArrayInput
- type SubnetGroupArrayOutput
- func (SubnetGroupArrayOutput) ElementType() reflect.Type
- func (o SubnetGroupArrayOutput) Index(i pulumi.IntInput) SubnetGroupOutput
- func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
- func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
- type SubnetGroupInput
- type SubnetGroupMap
- type SubnetGroupMapInput
- type SubnetGroupMapOutput
- func (SubnetGroupMapOutput) ElementType() reflect.Type
- func (o SubnetGroupMapOutput) MapIndex(k pulumi.StringInput) SubnetGroupOutput
- func (o SubnetGroupMapOutput) ToSubnetGroupMapOutput() SubnetGroupMapOutput
- func (o SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
- type SubnetGroupOutput
- func (o SubnetGroupOutput) Arn() pulumi.StringOutput
- func (o SubnetGroupOutput) Description() pulumi.StringOutput
- func (SubnetGroupOutput) ElementType() reflect.Type
- func (o SubnetGroupOutput) Name() pulumi.StringOutput
- func (o SubnetGroupOutput) NamePrefix() pulumi.StringOutput
- func (o SubnetGroupOutput) SubnetIds() pulumi.StringArrayOutput
- func (o SubnetGroupOutput) Tags() pulumi.StringMapOutput
- func (o SubnetGroupOutput) TagsAll() pulumi.StringMapOutputdeprecated
- func (o SubnetGroupOutput) ToSubnetGroupOutput() SubnetGroupOutput
- func (o SubnetGroupOutput) ToSubnetGroupOutputWithContext(ctx context.Context) 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 upgrades between different major versions are allowed. You must set it to `true` when providing an `engineVersion` parameter that uses a different major version than the DB cluster's current version. Default is `false`. AllowMajorVersionUpgrade pulumi.BoolOutput `pulumi:"allowMajorVersionUpgrade"` // 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"` // If set to true, tags are copied to any snapshot of the DB cluster that is created. CopyTagsToSnapshot pulumi.BoolPtrOutput `pulumi:"copyTagsToSnapshot"` // 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` and `slowquery`. 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 global cluster identifier specified on `neptune.GlobalCluster`. GlobalClusterIdentifier pulumi.StringPtrOutput `pulumi:"globalClusterIdentifier"` // The Route53 Hosted Zone ID of the endpoint HostedZoneId pulumi.StringOutput `pulumi:"hostedZoneId"` // Specifies whether or not 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.StringOutput `pulumi:"neptuneClusterParameterGroupName"` // The name of the DB parameter group to apply to all instances of the DB cluster. NeptuneInstanceParameterGroupName pulumi.StringPtrOutput `pulumi:"neptuneInstanceParameterGroupName"` // 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 regionE.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"` // If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes. ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationPtrOutput `pulumi:"serverlessV2ScalingConfiguration"` // 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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. SnapshotIdentifier pulumi.StringPtrOutput `pulumi:"snapshotIdentifier"` // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrOutput `pulumi:"storageEncrypted"` // Storage type associated with the cluster `standard/iopt1`. Default: `standard` StorageType pulumi.StringOutput `pulumi:"storageType"` // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // 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/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/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 } 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
Using `pulumi import`, import `aws_neptune_cluster` using the cluster identifier. For example:
```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 ¶
func (*Cluster) ToClusterOutput ¶
func (i *Cluster) ToClusterOutput() ClusterOutput
func (*Cluster) ToClusterOutputWithContext ¶
func (i *Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
type ClusterArgs ¶
type ClusterArgs struct { // Specifies whether upgrades between different major versions are allowed. You must set it to `true` when providing an `engineVersion` parameter that uses a different major version than the DB cluster's current version. Default is `false`. AllowMajorVersionUpgrade pulumi.BoolPtrInput // 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 // If set to true, tags are copied to any snapshot of the DB cluster that is created. CopyTagsToSnapshot pulumi.BoolPtrInput // 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` and `slowquery`. 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 // The global cluster identifier specified on `neptune.GlobalCluster`. GlobalClusterIdentifier pulumi.StringPtrInput // Specifies whether or not 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 // The name of the DB parameter group to apply to all instances of the DB cluster. NeptuneInstanceParameterGroupName 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 regionE.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 // If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes. ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationPtrInput // 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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. SnapshotIdentifier pulumi.StringPtrInput // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrInput // Storage type associated with the cluster `standard/iopt1`. Default: `standard` StorageType pulumi.StringPtrInput // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. 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 ClusterArray ¶
type ClusterArray []ClusterInput
func (ClusterArray) ElementType ¶
func (ClusterArray) ElementType() reflect.Type
func (ClusterArray) ToClusterArrayOutput ¶
func (i ClusterArray) ToClusterArrayOutput() ClusterArrayOutput
func (ClusterArray) ToClusterArrayOutputWithContext ¶
func (i ClusterArray) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput
type ClusterArrayInput ¶
type ClusterArrayInput interface { pulumi.Input ToClusterArrayOutput() ClusterArrayOutput ToClusterArrayOutputWithContext(context.Context) ClusterArrayOutput }
ClusterArrayInput is an input type that accepts ClusterArray and ClusterArrayOutput values. You can construct a concrete instance of `ClusterArrayInput` via:
ClusterArray{ ClusterArgs{...} }
type ClusterArrayOutput ¶
type ClusterArrayOutput struct{ *pulumi.OutputState }
func (ClusterArrayOutput) ElementType ¶
func (ClusterArrayOutput) ElementType() reflect.Type
func (ClusterArrayOutput) Index ¶
func (o ClusterArrayOutput) Index(i pulumi.IntInput) ClusterOutput
func (ClusterArrayOutput) ToClusterArrayOutput ¶
func (o ClusterArrayOutput) ToClusterArrayOutput() ClusterArrayOutput
func (ClusterArrayOutput) ToClusterArrayOutputWithContext ¶
func (o ClusterArrayOutput) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput
type ClusterEndpoint ¶
type ClusterEndpoint struct { pulumi.CustomResourceState // The Neptune Cluster Endpoint Amazon Resource Name (ARN). Arn pulumi.StringOutput `pulumi:"arn"` // The identifier of the endpoint. ClusterEndpointIdentifier pulumi.StringOutput `pulumi:"clusterEndpointIdentifier"` // The DB cluster identifier of the DB cluster associated with the endpoint. ClusterIdentifier pulumi.StringOutput `pulumi:"clusterIdentifier"` // The DNS address of the endpoint. Endpoint pulumi.StringOutput `pulumi:"endpoint"` // The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. EndpointType pulumi.StringOutput `pulumi:"endpointType"` // List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. ExcludedMembers pulumi.StringArrayOutput `pulumi:"excludedMembers"` // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers pulumi.StringArrayOutput `pulumi:"staticMembers"` // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides an Neptune Cluster Endpoint Resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewClusterEndpoint(ctx, "example", &neptune.ClusterEndpointArgs{ ClusterIdentifier: pulumi.Any(test.ClusterIdentifier), ClusterEndpointIdentifier: pulumi.String("example"), EndpointType: pulumi.String("READER"), }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import `aws_neptune_cluster_endpoint` using the `cluster-identifier:endpoint-identfier`. For example:
```sh $ pulumi import aws:neptune/clusterEndpoint:ClusterEndpoint example my-cluster:my-endpoint ```
func GetClusterEndpoint ¶
func GetClusterEndpoint(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ClusterEndpointState, opts ...pulumi.ResourceOption) (*ClusterEndpoint, error)
GetClusterEndpoint gets an existing ClusterEndpoint 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 NewClusterEndpoint ¶
func NewClusterEndpoint(ctx *pulumi.Context, name string, args *ClusterEndpointArgs, opts ...pulumi.ResourceOption) (*ClusterEndpoint, error)
NewClusterEndpoint registers a new resource with the given unique name, arguments, and options.
func (*ClusterEndpoint) ElementType ¶
func (*ClusterEndpoint) ElementType() reflect.Type
func (*ClusterEndpoint) ToClusterEndpointOutput ¶
func (i *ClusterEndpoint) ToClusterEndpointOutput() ClusterEndpointOutput
func (*ClusterEndpoint) ToClusterEndpointOutputWithContext ¶
func (i *ClusterEndpoint) ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput
type ClusterEndpointArgs ¶
type ClusterEndpointArgs struct { // The identifier of the endpoint. ClusterEndpointIdentifier pulumi.StringInput // The DB cluster identifier of the DB cluster associated with the endpoint. ClusterIdentifier pulumi.StringInput // The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. EndpointType pulumi.StringInput // List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. ExcludedMembers pulumi.StringArrayInput // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers pulumi.StringArrayInput // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a ClusterEndpoint resource.
func (ClusterEndpointArgs) ElementType ¶
func (ClusterEndpointArgs) ElementType() reflect.Type
type ClusterEndpointArray ¶
type ClusterEndpointArray []ClusterEndpointInput
func (ClusterEndpointArray) ElementType ¶
func (ClusterEndpointArray) ElementType() reflect.Type
func (ClusterEndpointArray) ToClusterEndpointArrayOutput ¶
func (i ClusterEndpointArray) ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput
func (ClusterEndpointArray) ToClusterEndpointArrayOutputWithContext ¶
func (i ClusterEndpointArray) ToClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterEndpointArrayOutput
type ClusterEndpointArrayInput ¶
type ClusterEndpointArrayInput interface { pulumi.Input ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput ToClusterEndpointArrayOutputWithContext(context.Context) ClusterEndpointArrayOutput }
ClusterEndpointArrayInput is an input type that accepts ClusterEndpointArray and ClusterEndpointArrayOutput values. You can construct a concrete instance of `ClusterEndpointArrayInput` via:
ClusterEndpointArray{ ClusterEndpointArgs{...} }
type ClusterEndpointArrayOutput ¶
type ClusterEndpointArrayOutput struct{ *pulumi.OutputState }
func (ClusterEndpointArrayOutput) ElementType ¶
func (ClusterEndpointArrayOutput) ElementType() reflect.Type
func (ClusterEndpointArrayOutput) Index ¶
func (o ClusterEndpointArrayOutput) Index(i pulumi.IntInput) ClusterEndpointOutput
func (ClusterEndpointArrayOutput) ToClusterEndpointArrayOutput ¶
func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput
func (ClusterEndpointArrayOutput) ToClusterEndpointArrayOutputWithContext ¶
func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterEndpointArrayOutput
type ClusterEndpointInput ¶
type ClusterEndpointInput interface { pulumi.Input ToClusterEndpointOutput() ClusterEndpointOutput ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput }
type ClusterEndpointMap ¶
type ClusterEndpointMap map[string]ClusterEndpointInput
func (ClusterEndpointMap) ElementType ¶
func (ClusterEndpointMap) ElementType() reflect.Type
func (ClusterEndpointMap) ToClusterEndpointMapOutput ¶
func (i ClusterEndpointMap) ToClusterEndpointMapOutput() ClusterEndpointMapOutput
func (ClusterEndpointMap) ToClusterEndpointMapOutputWithContext ¶
func (i ClusterEndpointMap) ToClusterEndpointMapOutputWithContext(ctx context.Context) ClusterEndpointMapOutput
type ClusterEndpointMapInput ¶
type ClusterEndpointMapInput interface { pulumi.Input ToClusterEndpointMapOutput() ClusterEndpointMapOutput ToClusterEndpointMapOutputWithContext(context.Context) ClusterEndpointMapOutput }
ClusterEndpointMapInput is an input type that accepts ClusterEndpointMap and ClusterEndpointMapOutput values. You can construct a concrete instance of `ClusterEndpointMapInput` via:
ClusterEndpointMap{ "key": ClusterEndpointArgs{...} }
type ClusterEndpointMapOutput ¶
type ClusterEndpointMapOutput struct{ *pulumi.OutputState }
func (ClusterEndpointMapOutput) ElementType ¶
func (ClusterEndpointMapOutput) ElementType() reflect.Type
func (ClusterEndpointMapOutput) MapIndex ¶
func (o ClusterEndpointMapOutput) MapIndex(k pulumi.StringInput) ClusterEndpointOutput
func (ClusterEndpointMapOutput) ToClusterEndpointMapOutput ¶
func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutput() ClusterEndpointMapOutput
func (ClusterEndpointMapOutput) ToClusterEndpointMapOutputWithContext ¶
func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutputWithContext(ctx context.Context) ClusterEndpointMapOutput
type ClusterEndpointOutput ¶
type ClusterEndpointOutput struct{ *pulumi.OutputState }
func (ClusterEndpointOutput) Arn ¶
func (o ClusterEndpointOutput) Arn() pulumi.StringOutput
The Neptune Cluster Endpoint Amazon Resource Name (ARN).
func (ClusterEndpointOutput) ClusterEndpointIdentifier ¶
func (o ClusterEndpointOutput) ClusterEndpointIdentifier() pulumi.StringOutput
The identifier of the endpoint.
func (ClusterEndpointOutput) ClusterIdentifier ¶
func (o ClusterEndpointOutput) ClusterIdentifier() pulumi.StringOutput
The DB cluster identifier of the DB cluster associated with the endpoint.
func (ClusterEndpointOutput) ElementType ¶
func (ClusterEndpointOutput) ElementType() reflect.Type
func (ClusterEndpointOutput) Endpoint ¶
func (o ClusterEndpointOutput) Endpoint() pulumi.StringOutput
The DNS address of the endpoint.
func (ClusterEndpointOutput) EndpointType ¶
func (o ClusterEndpointOutput) EndpointType() pulumi.StringOutput
The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.
func (ClusterEndpointOutput) ExcludedMembers ¶
func (o ClusterEndpointOutput) ExcludedMembers() pulumi.StringArrayOutput
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
func (ClusterEndpointOutput) StaticMembers ¶
func (o ClusterEndpointOutput) StaticMembers() pulumi.StringArrayOutput
List of DB instance identifiers that are part of the custom endpoint group.
func (ClusterEndpointOutput) Tags ¶
func (o ClusterEndpointOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (ClusterEndpointOutput) TagsAll
deprecated
func (o ClusterEndpointOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (ClusterEndpointOutput) ToClusterEndpointOutput ¶
func (o ClusterEndpointOutput) ToClusterEndpointOutput() ClusterEndpointOutput
func (ClusterEndpointOutput) ToClusterEndpointOutputWithContext ¶
func (o ClusterEndpointOutput) ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput
type ClusterEndpointState ¶
type ClusterEndpointState struct { // The Neptune Cluster Endpoint Amazon Resource Name (ARN). Arn pulumi.StringPtrInput // The identifier of the endpoint. ClusterEndpointIdentifier pulumi.StringPtrInput // The DB cluster identifier of the DB cluster associated with the endpoint. ClusterIdentifier pulumi.StringPtrInput // The DNS address of the endpoint. Endpoint pulumi.StringPtrInput // The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. EndpointType pulumi.StringPtrInput // List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. ExcludedMembers pulumi.StringArrayInput // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers pulumi.StringArrayInput // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (ClusterEndpointState) ElementType ¶
func (ClusterEndpointState) ElementType() reflect.Type
type ClusterInput ¶
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. Currently configuring this argumnet has no effect. 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.StringOutput `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"` // Determines whether a final DB snapshot is created before the DB instance is deleted. SkipFinalSnapshot pulumi.BoolPtrOutput `pulumi:"skipFinalSnapshot"` // Specifies whether the neptune cluster is encrypted. StorageEncrypted pulumi.BoolOutput `pulumi:"storageEncrypted"` // Storage type associated with the cluster `standard/iopt1`. StorageType pulumi.StringOutput `pulumi:"storageType"` // A map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // 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 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/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/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 index := 0; index < 2; index++ { key0 := index _ := index __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
Using `pulumi import`, import `aws_neptune_cluster_instance` using the instance identifier. For example:
```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 ¶
func (*ClusterInstance) ElementType() reflect.Type
func (*ClusterInstance) ToClusterInstanceOutput ¶
func (i *ClusterInstance) ToClusterInstanceOutput() ClusterInstanceOutput
func (*ClusterInstance) ToClusterInstanceOutputWithContext ¶
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. Currently configuring this argumnet has no effect. 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 // Determines whether a final DB snapshot is created before the DB instance is deleted. SkipFinalSnapshot pulumi.BoolPtrInput // A map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a ClusterInstance resource.
func (ClusterInstanceArgs) ElementType ¶
func (ClusterInstanceArgs) ElementType() reflect.Type
type ClusterInstanceArray ¶
type ClusterInstanceArray []ClusterInstanceInput
func (ClusterInstanceArray) ElementType ¶
func (ClusterInstanceArray) ElementType() reflect.Type
func (ClusterInstanceArray) ToClusterInstanceArrayOutput ¶
func (i ClusterInstanceArray) ToClusterInstanceArrayOutput() ClusterInstanceArrayOutput
func (ClusterInstanceArray) ToClusterInstanceArrayOutputWithContext ¶
func (i ClusterInstanceArray) ToClusterInstanceArrayOutputWithContext(ctx context.Context) ClusterInstanceArrayOutput
type ClusterInstanceArrayInput ¶
type ClusterInstanceArrayInput interface { pulumi.Input ToClusterInstanceArrayOutput() ClusterInstanceArrayOutput ToClusterInstanceArrayOutputWithContext(context.Context) ClusterInstanceArrayOutput }
ClusterInstanceArrayInput is an input type that accepts ClusterInstanceArray and ClusterInstanceArrayOutput values. You can construct a concrete instance of `ClusterInstanceArrayInput` via:
ClusterInstanceArray{ ClusterInstanceArgs{...} }
type ClusterInstanceArrayOutput ¶
type ClusterInstanceArrayOutput struct{ *pulumi.OutputState }
func (ClusterInstanceArrayOutput) ElementType ¶
func (ClusterInstanceArrayOutput) ElementType() reflect.Type
func (ClusterInstanceArrayOutput) Index ¶
func (o ClusterInstanceArrayOutput) Index(i pulumi.IntInput) ClusterInstanceOutput
func (ClusterInstanceArrayOutput) ToClusterInstanceArrayOutput ¶
func (o ClusterInstanceArrayOutput) ToClusterInstanceArrayOutput() ClusterInstanceArrayOutput
func (ClusterInstanceArrayOutput) ToClusterInstanceArrayOutputWithContext ¶
func (o ClusterInstanceArrayOutput) ToClusterInstanceArrayOutputWithContext(ctx context.Context) ClusterInstanceArrayOutput
type ClusterInstanceInput ¶
type ClusterInstanceInput interface { pulumi.Input ToClusterInstanceOutput() ClusterInstanceOutput ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput }
type ClusterInstanceMap ¶
type ClusterInstanceMap map[string]ClusterInstanceInput
func (ClusterInstanceMap) ElementType ¶
func (ClusterInstanceMap) ElementType() reflect.Type
func (ClusterInstanceMap) ToClusterInstanceMapOutput ¶
func (i ClusterInstanceMap) ToClusterInstanceMapOutput() ClusterInstanceMapOutput
func (ClusterInstanceMap) ToClusterInstanceMapOutputWithContext ¶
func (i ClusterInstanceMap) ToClusterInstanceMapOutputWithContext(ctx context.Context) ClusterInstanceMapOutput
type ClusterInstanceMapInput ¶
type ClusterInstanceMapInput interface { pulumi.Input ToClusterInstanceMapOutput() ClusterInstanceMapOutput ToClusterInstanceMapOutputWithContext(context.Context) ClusterInstanceMapOutput }
ClusterInstanceMapInput is an input type that accepts ClusterInstanceMap and ClusterInstanceMapOutput values. You can construct a concrete instance of `ClusterInstanceMapInput` via:
ClusterInstanceMap{ "key": ClusterInstanceArgs{...} }
type ClusterInstanceMapOutput ¶
type ClusterInstanceMapOutput struct{ *pulumi.OutputState }
func (ClusterInstanceMapOutput) ElementType ¶
func (ClusterInstanceMapOutput) ElementType() reflect.Type
func (ClusterInstanceMapOutput) MapIndex ¶
func (o ClusterInstanceMapOutput) MapIndex(k pulumi.StringInput) ClusterInstanceOutput
func (ClusterInstanceMapOutput) ToClusterInstanceMapOutput ¶
func (o ClusterInstanceMapOutput) ToClusterInstanceMapOutput() ClusterInstanceMapOutput
func (ClusterInstanceMapOutput) ToClusterInstanceMapOutputWithContext ¶
func (o ClusterInstanceMapOutput) ToClusterInstanceMapOutputWithContext(ctx context.Context) ClusterInstanceMapOutput
type ClusterInstanceOutput ¶
type ClusterInstanceOutput struct{ *pulumi.OutputState }
func (ClusterInstanceOutput) Address ¶
func (o ClusterInstanceOutput) Address() pulumi.StringOutput
The hostname of the instance. See also `endpoint` and `port`.
func (ClusterInstanceOutput) ApplyImmediately ¶
func (o ClusterInstanceOutput) ApplyImmediately() pulumi.BoolOutput
Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is`false`.
func (ClusterInstanceOutput) Arn ¶
func (o ClusterInstanceOutput) Arn() pulumi.StringOutput
Amazon Resource Name (ARN) of neptune instance
func (ClusterInstanceOutput) AutoMinorVersionUpgrade ¶
func (o ClusterInstanceOutput) AutoMinorVersionUpgrade() pulumi.BoolPtrOutput
Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`.
func (ClusterInstanceOutput) AvailabilityZone ¶
func (o ClusterInstanceOutput) AvailabilityZone() pulumi.StringOutput
The EC2 Availability Zone that the neptune instance is created in.
func (ClusterInstanceOutput) ClusterIdentifier ¶
func (o ClusterInstanceOutput) ClusterIdentifier() pulumi.StringOutput
The identifier of the `neptune.Cluster` in which to launch this instance.
func (ClusterInstanceOutput) DbiResourceId ¶
func (o ClusterInstanceOutput) DbiResourceId() pulumi.StringOutput
The region-unique, immutable identifier for the neptune instance.
func (ClusterInstanceOutput) ElementType ¶
func (ClusterInstanceOutput) ElementType() reflect.Type
func (ClusterInstanceOutput) Endpoint ¶
func (o ClusterInstanceOutput) Endpoint() pulumi.StringOutput
The connection endpoint in `address:port` format.
func (ClusterInstanceOutput) Engine ¶
func (o ClusterInstanceOutput) Engine() pulumi.StringPtrOutput
The name of the database engine to be used for the neptune instance. Defaults to `neptune`. Valid Values: `neptune`.
func (ClusterInstanceOutput) EngineVersion ¶
func (o ClusterInstanceOutput) EngineVersion() pulumi.StringOutput
The neptune engine version. Currently configuring this argumnet has no effect.
func (ClusterInstanceOutput) Identifier ¶
func (o ClusterInstanceOutput) Identifier() pulumi.StringOutput
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
func (ClusterInstanceOutput) IdentifierPrefix ¶
func (o ClusterInstanceOutput) IdentifierPrefix() pulumi.StringOutput
Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
func (ClusterInstanceOutput) InstanceClass ¶
func (o ClusterInstanceOutput) InstanceClass() pulumi.StringOutput
The instance class to use.
func (ClusterInstanceOutput) KmsKeyArn ¶
func (o ClusterInstanceOutput) KmsKeyArn() pulumi.StringOutput
The ARN for the KMS encryption key if one is set to the neptune cluster.
func (ClusterInstanceOutput) NeptuneParameterGroupName ¶
func (o ClusterInstanceOutput) NeptuneParameterGroupName() pulumi.StringOutput
The name of the neptune parameter group to associate with this instance.
func (ClusterInstanceOutput) NeptuneSubnetGroupName ¶
func (o ClusterInstanceOutput) NeptuneSubnetGroupName() pulumi.StringOutput
A subnet group to associate with this neptune instance. **NOTE:** This must match the `neptuneSubnetGroupName` of the attached `neptune.Cluster`.
func (ClusterInstanceOutput) Port ¶
func (o ClusterInstanceOutput) Port() pulumi.IntPtrOutput
The port on which the DB accepts connections. Defaults to `8182`.
func (ClusterInstanceOutput) PreferredBackupWindow ¶
func (o ClusterInstanceOutput) PreferredBackupWindow() pulumi.StringOutput
The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
func (ClusterInstanceOutput) PreferredMaintenanceWindow ¶
func (o ClusterInstanceOutput) PreferredMaintenanceWindow() pulumi.StringOutput
The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
func (ClusterInstanceOutput) PromotionTier ¶
func (o ClusterInstanceOutput) PromotionTier() pulumi.IntPtrOutput
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
func (ClusterInstanceOutput) PubliclyAccessible ¶
func (o ClusterInstanceOutput) PubliclyAccessible() pulumi.BoolPtrOutput
Bool to control if instance is publicly accessible. Default is `false`.
func (ClusterInstanceOutput) SkipFinalSnapshot ¶ added in v6.23.0
func (o ClusterInstanceOutput) SkipFinalSnapshot() pulumi.BoolPtrOutput
Determines whether a final DB snapshot is created before the DB instance is deleted.
func (ClusterInstanceOutput) StorageEncrypted ¶
func (o ClusterInstanceOutput) StorageEncrypted() pulumi.BoolOutput
Specifies whether the neptune cluster is encrypted.
func (ClusterInstanceOutput) StorageType ¶ added in v6.18.2
func (o ClusterInstanceOutput) StorageType() pulumi.StringOutput
Storage type associated with the cluster `standard/iopt1`.
func (ClusterInstanceOutput) Tags ¶
func (o ClusterInstanceOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (ClusterInstanceOutput) TagsAll
deprecated
func (o ClusterInstanceOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (ClusterInstanceOutput) ToClusterInstanceOutput ¶
func (o ClusterInstanceOutput) ToClusterInstanceOutput() ClusterInstanceOutput
func (ClusterInstanceOutput) ToClusterInstanceOutputWithContext ¶
func (o ClusterInstanceOutput) ToClusterInstanceOutputWithContext(ctx context.Context) ClusterInstanceOutput
func (ClusterInstanceOutput) Writer ¶
func (o ClusterInstanceOutput) Writer() pulumi.BoolOutput
Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.
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. Currently configuring this argumnet has no effect. 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 // Determines whether a final DB snapshot is created before the DB instance is deleted. SkipFinalSnapshot pulumi.BoolPtrInput // Specifies whether the neptune cluster is encrypted. StorageEncrypted pulumi.BoolPtrInput // Storage type associated with the cluster `standard/iopt1`. StorageType pulumi.StringPtrInput // A map of tags to assign to the instance. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll 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 ClusterMap ¶
type ClusterMap map[string]ClusterInput
func (ClusterMap) ElementType ¶
func (ClusterMap) ElementType() reflect.Type
func (ClusterMap) ToClusterMapOutput ¶
func (i ClusterMap) ToClusterMapOutput() ClusterMapOutput
func (ClusterMap) ToClusterMapOutputWithContext ¶
func (i ClusterMap) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput
type ClusterMapInput ¶
type ClusterMapInput interface { pulumi.Input ToClusterMapOutput() ClusterMapOutput ToClusterMapOutputWithContext(context.Context) ClusterMapOutput }
ClusterMapInput is an input type that accepts ClusterMap and ClusterMapOutput values. You can construct a concrete instance of `ClusterMapInput` via:
ClusterMap{ "key": ClusterArgs{...} }
type ClusterMapOutput ¶
type ClusterMapOutput struct{ *pulumi.OutputState }
func (ClusterMapOutput) ElementType ¶
func (ClusterMapOutput) ElementType() reflect.Type
func (ClusterMapOutput) MapIndex ¶
func (o ClusterMapOutput) MapIndex(k pulumi.StringInput) ClusterOutput
func (ClusterMapOutput) ToClusterMapOutput ¶
func (o ClusterMapOutput) ToClusterMapOutput() ClusterMapOutput
func (ClusterMapOutput) ToClusterMapOutputWithContext ¶
func (o ClusterMapOutput) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput
type ClusterOutput ¶
type ClusterOutput struct{ *pulumi.OutputState }
func (ClusterOutput) AllowMajorVersionUpgrade ¶
func (o ClusterOutput) AllowMajorVersionUpgrade() pulumi.BoolOutput
Specifies whether upgrades between different major versions are allowed. You must set it to `true` when providing an `engineVersion` parameter that uses a different major version than the DB cluster's current version. Default is `false`.
func (ClusterOutput) ApplyImmediately ¶
func (o ClusterOutput) ApplyImmediately() pulumi.BoolOutput
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.
func (ClusterOutput) Arn ¶
func (o ClusterOutput) Arn() pulumi.StringOutput
The Neptune Cluster Amazon Resource Name (ARN)
func (ClusterOutput) AvailabilityZones ¶
func (o ClusterOutput) AvailabilityZones() pulumi.StringArrayOutput
A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
func (ClusterOutput) BackupRetentionPeriod ¶
func (o ClusterOutput) BackupRetentionPeriod() pulumi.IntPtrOutput
The days to retain backups for. Default `1`
func (ClusterOutput) ClusterIdentifier ¶
func (o ClusterOutput) ClusterIdentifier() pulumi.StringOutput
The cluster identifier. If omitted, this provider will assign a random, unique identifier.
func (ClusterOutput) ClusterIdentifierPrefix ¶
func (o ClusterOutput) ClusterIdentifierPrefix() pulumi.StringOutput
Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.
func (ClusterOutput) ClusterMembers ¶
func (o ClusterOutput) ClusterMembers() pulumi.StringArrayOutput
List of Neptune Instances that are a part of this cluster
func (ClusterOutput) ClusterResourceId ¶
func (o ClusterOutput) ClusterResourceId() pulumi.StringOutput
The Neptune Cluster Resource ID
func (ClusterOutput) CopyTagsToSnapshot ¶
func (o ClusterOutput) CopyTagsToSnapshot() pulumi.BoolPtrOutput
If set to true, tags are copied to any snapshot of the DB cluster that is created.
func (ClusterOutput) DeletionProtection ¶
func (o ClusterOutput) DeletionProtection() pulumi.BoolPtrOutput
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.
func (ClusterOutput) ElementType ¶
func (ClusterOutput) ElementType() reflect.Type
func (ClusterOutput) EnableCloudwatchLogsExports ¶
func (o ClusterOutput) EnableCloudwatchLogsExports() pulumi.StringArrayOutput
A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit` and `slowquery`.
func (ClusterOutput) Endpoint ¶
func (o ClusterOutput) Endpoint() pulumi.StringOutput
The DNS address of the Neptune instance
func (ClusterOutput) Engine ¶
func (o ClusterOutput) Engine() pulumi.StringPtrOutput
The name of the database engine to be used for this Neptune cluster. Defaults to `neptune`.
func (ClusterOutput) EngineVersion ¶
func (o ClusterOutput) EngineVersion() pulumi.StringOutput
The database engine version.
func (ClusterOutput) FinalSnapshotIdentifier ¶
func (o ClusterOutput) FinalSnapshotIdentifier() pulumi.StringPtrOutput
The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
func (ClusterOutput) GlobalClusterIdentifier ¶
func (o ClusterOutput) GlobalClusterIdentifier() pulumi.StringPtrOutput
The global cluster identifier specified on `neptune.GlobalCluster`.
func (ClusterOutput) HostedZoneId ¶
func (o ClusterOutput) HostedZoneId() pulumi.StringOutput
The Route53 Hosted Zone ID of the endpoint
func (ClusterOutput) IamDatabaseAuthenticationEnabled ¶
func (o ClusterOutput) IamDatabaseAuthenticationEnabled() pulumi.BoolPtrOutput
Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
func (ClusterOutput) IamRoles ¶
func (o ClusterOutput) IamRoles() pulumi.StringArrayOutput
A List of ARNs for the IAM roles to associate to the Neptune Cluster.
func (ClusterOutput) KmsKeyArn ¶
func (o ClusterOutput) KmsKeyArn() pulumi.StringOutput
The ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true.
func (ClusterOutput) NeptuneClusterParameterGroupName ¶
func (o ClusterOutput) NeptuneClusterParameterGroupName() pulumi.StringOutput
A cluster parameter group to associate with the cluster.
func (ClusterOutput) NeptuneInstanceParameterGroupName ¶
func (o ClusterOutput) NeptuneInstanceParameterGroupName() pulumi.StringPtrOutput
The name of the DB parameter group to apply to all instances of the DB cluster.
func (ClusterOutput) NeptuneSubnetGroupName ¶
func (o ClusterOutput) NeptuneSubnetGroupName() pulumi.StringOutput
A Neptune subnet group to associate with this Neptune instance.
func (ClusterOutput) Port ¶
func (o ClusterOutput) Port() pulumi.IntPtrOutput
The port on which the Neptune accepts connections. Default is `8182`.
func (ClusterOutput) PreferredBackupWindow ¶
func (o ClusterOutput) PreferredBackupWindow() pulumi.StringOutput
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
func (ClusterOutput) PreferredMaintenanceWindow ¶
func (o ClusterOutput) PreferredMaintenanceWindow() pulumi.StringOutput
The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
func (ClusterOutput) ReaderEndpoint ¶
func (o ClusterOutput) ReaderEndpoint() pulumi.StringOutput
A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
func (ClusterOutput) ReplicationSourceIdentifier ¶
func (o ClusterOutput) ReplicationSourceIdentifier() pulumi.StringPtrOutput
ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
func (ClusterOutput) ServerlessV2ScalingConfiguration ¶
func (o ClusterOutput) ServerlessV2ScalingConfiguration() ClusterServerlessV2ScalingConfigurationPtrOutput
If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
func (ClusterOutput) SkipFinalSnapshot ¶
func (o ClusterOutput) SkipFinalSnapshot() pulumi.BoolPtrOutput
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`.
func (ClusterOutput) SnapshotIdentifier ¶
func (o ClusterOutput) SnapshotIdentifier() pulumi.StringPtrOutput
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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
func (ClusterOutput) StorageEncrypted ¶
func (o ClusterOutput) StorageEncrypted() pulumi.BoolPtrOutput
Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified.
func (ClusterOutput) StorageType ¶ added in v6.18.2
func (o ClusterOutput) StorageType() pulumi.StringOutput
Storage type associated with the cluster `standard/iopt1`. Default: `standard`
func (ClusterOutput) Tags ¶
func (o ClusterOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (ClusterOutput) TagsAll
deprecated
func (o ClusterOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (ClusterOutput) ToClusterOutput ¶
func (o ClusterOutput) ToClusterOutput() ClusterOutput
func (ClusterOutput) ToClusterOutputWithContext ¶
func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
func (ClusterOutput) VpcSecurityGroupIds ¶
func (o ClusterOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput
List of VPC security groups to associate with the Cluster
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Manages a Neptune Cluster Parameter Group
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewClusterParameterGroup(ctx, "example", &neptune.ClusterParameterGroupArgs{ Family: pulumi.String("neptune1"), Name: pulumi.String("example"), Description: pulumi.String("neptune cluster parameter group"), Parameters: neptune.ClusterParameterGroupParameterArray{ &neptune.ClusterParameterGroupParameterArgs{ Name: pulumi.String("neptune_enable_audit_log"), Value: pulumi.String("1"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import Neptune Cluster Parameter Groups using the `name`. For example:
```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 ¶
func (*ClusterParameterGroup) ElementType() reflect.Type
func (*ClusterParameterGroup) ToClusterParameterGroupOutput ¶
func (i *ClusterParameterGroup) ToClusterParameterGroupOutput() ClusterParameterGroupOutput
func (*ClusterParameterGroup) ToClusterParameterGroupOutputWithContext ¶
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a ClusterParameterGroup resource.
func (ClusterParameterGroupArgs) ElementType ¶
func (ClusterParameterGroupArgs) ElementType() reflect.Type
type ClusterParameterGroupArray ¶
type ClusterParameterGroupArray []ClusterParameterGroupInput
func (ClusterParameterGroupArray) ElementType ¶
func (ClusterParameterGroupArray) ElementType() reflect.Type
func (ClusterParameterGroupArray) ToClusterParameterGroupArrayOutput ¶
func (i ClusterParameterGroupArray) ToClusterParameterGroupArrayOutput() ClusterParameterGroupArrayOutput
func (ClusterParameterGroupArray) ToClusterParameterGroupArrayOutputWithContext ¶
func (i ClusterParameterGroupArray) ToClusterParameterGroupArrayOutputWithContext(ctx context.Context) ClusterParameterGroupArrayOutput
type ClusterParameterGroupArrayInput ¶
type ClusterParameterGroupArrayInput interface { pulumi.Input ToClusterParameterGroupArrayOutput() ClusterParameterGroupArrayOutput ToClusterParameterGroupArrayOutputWithContext(context.Context) ClusterParameterGroupArrayOutput }
ClusterParameterGroupArrayInput is an input type that accepts ClusterParameterGroupArray and ClusterParameterGroupArrayOutput values. You can construct a concrete instance of `ClusterParameterGroupArrayInput` via:
ClusterParameterGroupArray{ ClusterParameterGroupArgs{...} }
type ClusterParameterGroupArrayOutput ¶
type ClusterParameterGroupArrayOutput struct{ *pulumi.OutputState }
func (ClusterParameterGroupArrayOutput) ElementType ¶
func (ClusterParameterGroupArrayOutput) ElementType() reflect.Type
func (ClusterParameterGroupArrayOutput) Index ¶
func (o ClusterParameterGroupArrayOutput) Index(i pulumi.IntInput) ClusterParameterGroupOutput
func (ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutput ¶
func (o ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutput() ClusterParameterGroupArrayOutput
func (ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutputWithContext ¶
func (o ClusterParameterGroupArrayOutput) ToClusterParameterGroupArrayOutputWithContext(ctx context.Context) ClusterParameterGroupArrayOutput
type ClusterParameterGroupInput ¶
type ClusterParameterGroupInput interface { pulumi.Input ToClusterParameterGroupOutput() ClusterParameterGroupOutput ToClusterParameterGroupOutputWithContext(ctx context.Context) ClusterParameterGroupOutput }
type ClusterParameterGroupMap ¶
type ClusterParameterGroupMap map[string]ClusterParameterGroupInput
func (ClusterParameterGroupMap) ElementType ¶
func (ClusterParameterGroupMap) ElementType() reflect.Type
func (ClusterParameterGroupMap) ToClusterParameterGroupMapOutput ¶
func (i ClusterParameterGroupMap) ToClusterParameterGroupMapOutput() ClusterParameterGroupMapOutput
func (ClusterParameterGroupMap) ToClusterParameterGroupMapOutputWithContext ¶
func (i ClusterParameterGroupMap) ToClusterParameterGroupMapOutputWithContext(ctx context.Context) ClusterParameterGroupMapOutput
type ClusterParameterGroupMapInput ¶
type ClusterParameterGroupMapInput interface { pulumi.Input ToClusterParameterGroupMapOutput() ClusterParameterGroupMapOutput ToClusterParameterGroupMapOutputWithContext(context.Context) ClusterParameterGroupMapOutput }
ClusterParameterGroupMapInput is an input type that accepts ClusterParameterGroupMap and ClusterParameterGroupMapOutput values. You can construct a concrete instance of `ClusterParameterGroupMapInput` via:
ClusterParameterGroupMap{ "key": ClusterParameterGroupArgs{...} }
type ClusterParameterGroupMapOutput ¶
type ClusterParameterGroupMapOutput struct{ *pulumi.OutputState }
func (ClusterParameterGroupMapOutput) ElementType ¶
func (ClusterParameterGroupMapOutput) ElementType() reflect.Type
func (ClusterParameterGroupMapOutput) MapIndex ¶
func (o ClusterParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ClusterParameterGroupOutput
func (ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutput ¶
func (o ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutput() ClusterParameterGroupMapOutput
func (ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutputWithContext ¶
func (o ClusterParameterGroupMapOutput) ToClusterParameterGroupMapOutputWithContext(ctx context.Context) ClusterParameterGroupMapOutput
type ClusterParameterGroupOutput ¶
type ClusterParameterGroupOutput struct{ *pulumi.OutputState }
func (ClusterParameterGroupOutput) Arn ¶
func (o ClusterParameterGroupOutput) Arn() pulumi.StringOutput
The ARN of the neptune cluster parameter group.
func (ClusterParameterGroupOutput) Description ¶
func (o ClusterParameterGroupOutput) Description() pulumi.StringPtrOutput
The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
func (ClusterParameterGroupOutput) ElementType ¶
func (ClusterParameterGroupOutput) ElementType() reflect.Type
func (ClusterParameterGroupOutput) Family ¶
func (o ClusterParameterGroupOutput) Family() pulumi.StringOutput
The family of the neptune cluster parameter group.
func (ClusterParameterGroupOutput) Name ¶
func (o ClusterParameterGroupOutput) Name() pulumi.StringOutput
The name of the neptune parameter.
func (ClusterParameterGroupOutput) NamePrefix ¶
func (o ClusterParameterGroupOutput) NamePrefix() pulumi.StringOutput
Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (ClusterParameterGroupOutput) Parameters ¶
func (o ClusterParameterGroupOutput) Parameters() ClusterParameterGroupParameterArrayOutput
A list of neptune parameters to apply.
func (ClusterParameterGroupOutput) Tags ¶
func (o ClusterParameterGroupOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (ClusterParameterGroupOutput) TagsAll
deprecated
func (o ClusterParameterGroupOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (ClusterParameterGroupOutput) ToClusterParameterGroupOutput ¶
func (o ClusterParameterGroupOutput) ToClusterParameterGroupOutput() ClusterParameterGroupOutput
func (ClusterParameterGroupOutput) ToClusterParameterGroupOutputWithContext ¶
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (ClusterParameterGroupState) ElementType ¶
func (ClusterParameterGroupState) ElementType() reflect.Type
type ClusterServerlessV2ScalingConfiguration ¶
type ClusterServerlessV2ScalingConfiguration struct { // The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than **128**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details. MaxCapacity *float64 `pulumi:"maxCapacity"` // The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than **1**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details. MinCapacity *float64 `pulumi:"minCapacity"` }
type ClusterServerlessV2ScalingConfigurationArgs ¶
type ClusterServerlessV2ScalingConfigurationArgs struct { // The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than **128**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details. MaxCapacity pulumi.Float64PtrInput `pulumi:"maxCapacity"` // The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than **1**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details. MinCapacity pulumi.Float64PtrInput `pulumi:"minCapacity"` }
func (ClusterServerlessV2ScalingConfigurationArgs) ElementType ¶
func (ClusterServerlessV2ScalingConfigurationArgs) ElementType() reflect.Type
func (ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutput ¶
func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutput() ClusterServerlessV2ScalingConfigurationOutput
func (ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutputWithContext ¶
func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationOutput
func (ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutput ¶
func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
func (ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext ¶
func (i ClusterServerlessV2ScalingConfigurationArgs) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
type ClusterServerlessV2ScalingConfigurationInput ¶
type ClusterServerlessV2ScalingConfigurationInput interface { pulumi.Input ToClusterServerlessV2ScalingConfigurationOutput() ClusterServerlessV2ScalingConfigurationOutput ToClusterServerlessV2ScalingConfigurationOutputWithContext(context.Context) ClusterServerlessV2ScalingConfigurationOutput }
ClusterServerlessV2ScalingConfigurationInput is an input type that accepts ClusterServerlessV2ScalingConfigurationArgs and ClusterServerlessV2ScalingConfigurationOutput values. You can construct a concrete instance of `ClusterServerlessV2ScalingConfigurationInput` via:
ClusterServerlessV2ScalingConfigurationArgs{...}
type ClusterServerlessV2ScalingConfigurationOutput ¶
type ClusterServerlessV2ScalingConfigurationOutput struct{ *pulumi.OutputState }
func (ClusterServerlessV2ScalingConfigurationOutput) ElementType ¶
func (ClusterServerlessV2ScalingConfigurationOutput) ElementType() reflect.Type
func (ClusterServerlessV2ScalingConfigurationOutput) MaxCapacity ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) MaxCapacity() pulumi.Float64PtrOutput
The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than **128**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details.
func (ClusterServerlessV2ScalingConfigurationOutput) MinCapacity ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) MinCapacity() pulumi.Float64PtrOutput
The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than **1**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details.
func (ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutput ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutput() ClusterServerlessV2ScalingConfigurationOutput
func (ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutputWithContext ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationOutput
func (ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
func (ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext ¶
func (o ClusterServerlessV2ScalingConfigurationOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
type ClusterServerlessV2ScalingConfigurationPtrInput ¶
type ClusterServerlessV2ScalingConfigurationPtrInput interface { pulumi.Input ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput }
ClusterServerlessV2ScalingConfigurationPtrInput is an input type that accepts ClusterServerlessV2ScalingConfigurationArgs, ClusterServerlessV2ScalingConfigurationPtr and ClusterServerlessV2ScalingConfigurationPtrOutput values. You can construct a concrete instance of `ClusterServerlessV2ScalingConfigurationPtrInput` via:
ClusterServerlessV2ScalingConfigurationArgs{...} or: nil
func ClusterServerlessV2ScalingConfigurationPtr ¶
func ClusterServerlessV2ScalingConfigurationPtr(v *ClusterServerlessV2ScalingConfigurationArgs) ClusterServerlessV2ScalingConfigurationPtrInput
type ClusterServerlessV2ScalingConfigurationPtrOutput ¶
type ClusterServerlessV2ScalingConfigurationPtrOutput struct{ *pulumi.OutputState }
func (ClusterServerlessV2ScalingConfigurationPtrOutput) ElementType ¶
func (ClusterServerlessV2ScalingConfigurationPtrOutput) ElementType() reflect.Type
func (ClusterServerlessV2ScalingConfigurationPtrOutput) MaxCapacity ¶
func (o ClusterServerlessV2ScalingConfigurationPtrOutput) MaxCapacity() pulumi.Float64PtrOutput
The maximum Neptune Capacity Units (NCUs) for this cluster. Must be lower or equal than **128**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details.
func (ClusterServerlessV2ScalingConfigurationPtrOutput) MinCapacity ¶
func (o ClusterServerlessV2ScalingConfigurationPtrOutput) MinCapacity() pulumi.Float64PtrOutput
The minimum Neptune Capacity Units (NCUs) for this cluster. Must be greater or equal than **1**. See [AWS Documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html) for more details.
func (ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput ¶
func (o ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutput() ClusterServerlessV2ScalingConfigurationPtrOutput
func (ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext ¶
func (o ClusterServerlessV2ScalingConfigurationPtrOutput) ToClusterServerlessV2ScalingConfigurationPtrOutputWithContext(ctx context.Context) ClusterServerlessV2ScalingConfigurationPtrOutput
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/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewClusterSnapshot(ctx, "example", &neptune.ClusterSnapshotArgs{ DbClusterIdentifier: pulumi.Any(exampleAwsNeptuneCluster.Id), DbClusterSnapshotIdentifier: pulumi.String("resourcetestsnapshot1234"), }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import `aws_neptune_cluster_snapshot` using the cluster snapshot identifier. For example:
```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 ¶
func (*ClusterSnapshot) ElementType() reflect.Type
func (*ClusterSnapshot) ToClusterSnapshotOutput ¶
func (i *ClusterSnapshot) ToClusterSnapshotOutput() ClusterSnapshotOutput
func (*ClusterSnapshot) ToClusterSnapshotOutputWithContext ¶
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 ClusterSnapshotArray ¶
type ClusterSnapshotArray []ClusterSnapshotInput
func (ClusterSnapshotArray) ElementType ¶
func (ClusterSnapshotArray) ElementType() reflect.Type
func (ClusterSnapshotArray) ToClusterSnapshotArrayOutput ¶
func (i ClusterSnapshotArray) ToClusterSnapshotArrayOutput() ClusterSnapshotArrayOutput
func (ClusterSnapshotArray) ToClusterSnapshotArrayOutputWithContext ¶
func (i ClusterSnapshotArray) ToClusterSnapshotArrayOutputWithContext(ctx context.Context) ClusterSnapshotArrayOutput
type ClusterSnapshotArrayInput ¶
type ClusterSnapshotArrayInput interface { pulumi.Input ToClusterSnapshotArrayOutput() ClusterSnapshotArrayOutput ToClusterSnapshotArrayOutputWithContext(context.Context) ClusterSnapshotArrayOutput }
ClusterSnapshotArrayInput is an input type that accepts ClusterSnapshotArray and ClusterSnapshotArrayOutput values. You can construct a concrete instance of `ClusterSnapshotArrayInput` via:
ClusterSnapshotArray{ ClusterSnapshotArgs{...} }
type ClusterSnapshotArrayOutput ¶
type ClusterSnapshotArrayOutput struct{ *pulumi.OutputState }
func (ClusterSnapshotArrayOutput) ElementType ¶
func (ClusterSnapshotArrayOutput) ElementType() reflect.Type
func (ClusterSnapshotArrayOutput) Index ¶
func (o ClusterSnapshotArrayOutput) Index(i pulumi.IntInput) ClusterSnapshotOutput
func (ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutput ¶
func (o ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutput() ClusterSnapshotArrayOutput
func (ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutputWithContext ¶
func (o ClusterSnapshotArrayOutput) ToClusterSnapshotArrayOutputWithContext(ctx context.Context) ClusterSnapshotArrayOutput
type ClusterSnapshotInput ¶
type ClusterSnapshotInput interface { pulumi.Input ToClusterSnapshotOutput() ClusterSnapshotOutput ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput }
type ClusterSnapshotMap ¶
type ClusterSnapshotMap map[string]ClusterSnapshotInput
func (ClusterSnapshotMap) ElementType ¶
func (ClusterSnapshotMap) ElementType() reflect.Type
func (ClusterSnapshotMap) ToClusterSnapshotMapOutput ¶
func (i ClusterSnapshotMap) ToClusterSnapshotMapOutput() ClusterSnapshotMapOutput
func (ClusterSnapshotMap) ToClusterSnapshotMapOutputWithContext ¶
func (i ClusterSnapshotMap) ToClusterSnapshotMapOutputWithContext(ctx context.Context) ClusterSnapshotMapOutput
type ClusterSnapshotMapInput ¶
type ClusterSnapshotMapInput interface { pulumi.Input ToClusterSnapshotMapOutput() ClusterSnapshotMapOutput ToClusterSnapshotMapOutputWithContext(context.Context) ClusterSnapshotMapOutput }
ClusterSnapshotMapInput is an input type that accepts ClusterSnapshotMap and ClusterSnapshotMapOutput values. You can construct a concrete instance of `ClusterSnapshotMapInput` via:
ClusterSnapshotMap{ "key": ClusterSnapshotArgs{...} }
type ClusterSnapshotMapOutput ¶
type ClusterSnapshotMapOutput struct{ *pulumi.OutputState }
func (ClusterSnapshotMapOutput) ElementType ¶
func (ClusterSnapshotMapOutput) ElementType() reflect.Type
func (ClusterSnapshotMapOutput) MapIndex ¶
func (o ClusterSnapshotMapOutput) MapIndex(k pulumi.StringInput) ClusterSnapshotOutput
func (ClusterSnapshotMapOutput) ToClusterSnapshotMapOutput ¶
func (o ClusterSnapshotMapOutput) ToClusterSnapshotMapOutput() ClusterSnapshotMapOutput
func (ClusterSnapshotMapOutput) ToClusterSnapshotMapOutputWithContext ¶
func (o ClusterSnapshotMapOutput) ToClusterSnapshotMapOutputWithContext(ctx context.Context) ClusterSnapshotMapOutput
type ClusterSnapshotOutput ¶
type ClusterSnapshotOutput struct{ *pulumi.OutputState }
func (ClusterSnapshotOutput) AllocatedStorage ¶
func (o ClusterSnapshotOutput) AllocatedStorage() pulumi.IntOutput
Specifies the allocated storage size in gigabytes (GB).
func (ClusterSnapshotOutput) AvailabilityZones ¶
func (o ClusterSnapshotOutput) AvailabilityZones() pulumi.StringArrayOutput
List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
func (ClusterSnapshotOutput) DbClusterIdentifier ¶
func (o ClusterSnapshotOutput) DbClusterIdentifier() pulumi.StringOutput
The DB Cluster Identifier from which to take the snapshot.
func (ClusterSnapshotOutput) DbClusterSnapshotArn ¶
func (o ClusterSnapshotOutput) DbClusterSnapshotArn() pulumi.StringOutput
The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
func (ClusterSnapshotOutput) DbClusterSnapshotIdentifier ¶
func (o ClusterSnapshotOutput) DbClusterSnapshotIdentifier() pulumi.StringOutput
The Identifier for the snapshot.
func (ClusterSnapshotOutput) ElementType ¶
func (ClusterSnapshotOutput) ElementType() reflect.Type
func (ClusterSnapshotOutput) Engine ¶
func (o ClusterSnapshotOutput) Engine() pulumi.StringOutput
Specifies the name of the database engine.
func (ClusterSnapshotOutput) EngineVersion ¶
func (o ClusterSnapshotOutput) EngineVersion() pulumi.StringOutput
Version of the database engine for this DB cluster snapshot.
func (ClusterSnapshotOutput) KmsKeyId ¶
func (o ClusterSnapshotOutput) KmsKeyId() pulumi.StringOutput
If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
func (ClusterSnapshotOutput) LicenseModel ¶
func (o ClusterSnapshotOutput) LicenseModel() pulumi.StringOutput
License model information for the restored DB cluster.
func (ClusterSnapshotOutput) Port ¶
func (o ClusterSnapshotOutput) Port() pulumi.IntOutput
Port that the DB cluster was listening on at the time of the snapshot.
func (ClusterSnapshotOutput) SnapshotType ¶
func (o ClusterSnapshotOutput) SnapshotType() pulumi.StringOutput
func (ClusterSnapshotOutput) SourceDbClusterSnapshotArn ¶
func (o ClusterSnapshotOutput) SourceDbClusterSnapshotArn() pulumi.StringOutput
func (ClusterSnapshotOutput) Status ¶
func (o ClusterSnapshotOutput) Status() pulumi.StringOutput
The status of this DB Cluster Snapshot.
func (ClusterSnapshotOutput) StorageEncrypted ¶
func (o ClusterSnapshotOutput) StorageEncrypted() pulumi.BoolOutput
Specifies whether the DB cluster snapshot is encrypted.
func (ClusterSnapshotOutput) ToClusterSnapshotOutput ¶
func (o ClusterSnapshotOutput) ToClusterSnapshotOutput() ClusterSnapshotOutput
func (ClusterSnapshotOutput) ToClusterSnapshotOutputWithContext ¶
func (o ClusterSnapshotOutput) ToClusterSnapshotOutputWithContext(ctx context.Context) ClusterSnapshotOutput
func (ClusterSnapshotOutput) VpcId ¶
func (o ClusterSnapshotOutput) VpcId() pulumi.StringOutput
The VPC ID associated with the DB cluster snapshot.
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 upgrades between different major versions are allowed. You must set it to `true` when providing an `engineVersion` parameter that uses a different major version than the DB cluster's current version. Default is `false`. AllowMajorVersionUpgrade pulumi.BoolPtrInput // 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 // If set to true, tags are copied to any snapshot of the DB cluster that is created. CopyTagsToSnapshot pulumi.BoolPtrInput // 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` and `slowquery`. 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 global cluster identifier specified on `neptune.GlobalCluster`. GlobalClusterIdentifier pulumi.StringPtrInput // The Route53 Hosted Zone ID of the endpoint HostedZoneId pulumi.StringPtrInput // Specifies whether or not 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 // The name of the DB parameter group to apply to all instances of the DB cluster. NeptuneInstanceParameterGroupName 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 regionE.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 // If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes. ServerlessV2ScalingConfiguration ClusterServerlessV2ScalingConfigurationPtrInput // 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. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. SnapshotIdentifier pulumi.StringPtrInput // Specifies whether the Neptune cluster is encrypted. The default is `false` if not specified. StorageEncrypted pulumi.BoolPtrInput // Storage type associated with the cluster `standard/iopt1`. Default: `standard` StorageType pulumi.StringPtrInput // A map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll 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 // The Amazon Resource Name of the Neptune event notification subscription. Arn pulumi.StringOutput `pulumi:"arn"` // The AWS customer account associated with the Neptune event notification subscription. 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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns" "github.com/pulumi/pulumi/sdk/v3/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 } example, err := neptune.NewClusterInstance(ctx, "example", &neptune.ClusterInstanceArgs{ ClusterIdentifier: _default.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, "default", &sns.TopicArgs{ Name: pulumi.String("neptune-events"), }) if err != nil { return err } _, err = neptune.NewEventSubscription(ctx, "default", &neptune.EventSubscriptionArgs{ Name: pulumi.String("neptune-event-sub"), 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 }) }
```
## Import
Using `pulumi import`, import `aws_neptune_event_subscription` using the event subscription name. For example:
```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 ¶
func (*EventSubscription) ElementType() reflect.Type
func (*EventSubscription) ToEventSubscriptionOutput ¶
func (i *EventSubscription) ToEventSubscriptionOutput() EventSubscriptionOutput
func (*EventSubscription) ToEventSubscriptionOutputWithContext ¶
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a EventSubscription resource.
func (EventSubscriptionArgs) ElementType ¶
func (EventSubscriptionArgs) ElementType() reflect.Type
type EventSubscriptionArray ¶
type EventSubscriptionArray []EventSubscriptionInput
func (EventSubscriptionArray) ElementType ¶
func (EventSubscriptionArray) ElementType() reflect.Type
func (EventSubscriptionArray) ToEventSubscriptionArrayOutput ¶
func (i EventSubscriptionArray) ToEventSubscriptionArrayOutput() EventSubscriptionArrayOutput
func (EventSubscriptionArray) ToEventSubscriptionArrayOutputWithContext ¶
func (i EventSubscriptionArray) ToEventSubscriptionArrayOutputWithContext(ctx context.Context) EventSubscriptionArrayOutput
type EventSubscriptionArrayInput ¶
type EventSubscriptionArrayInput interface { pulumi.Input ToEventSubscriptionArrayOutput() EventSubscriptionArrayOutput ToEventSubscriptionArrayOutputWithContext(context.Context) EventSubscriptionArrayOutput }
EventSubscriptionArrayInput is an input type that accepts EventSubscriptionArray and EventSubscriptionArrayOutput values. You can construct a concrete instance of `EventSubscriptionArrayInput` via:
EventSubscriptionArray{ EventSubscriptionArgs{...} }
type EventSubscriptionArrayOutput ¶
type EventSubscriptionArrayOutput struct{ *pulumi.OutputState }
func (EventSubscriptionArrayOutput) ElementType ¶
func (EventSubscriptionArrayOutput) ElementType() reflect.Type
func (EventSubscriptionArrayOutput) Index ¶
func (o EventSubscriptionArrayOutput) Index(i pulumi.IntInput) EventSubscriptionOutput
func (EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutput ¶
func (o EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutput() EventSubscriptionArrayOutput
func (EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutputWithContext ¶
func (o EventSubscriptionArrayOutput) ToEventSubscriptionArrayOutputWithContext(ctx context.Context) EventSubscriptionArrayOutput
type EventSubscriptionInput ¶
type EventSubscriptionInput interface { pulumi.Input ToEventSubscriptionOutput() EventSubscriptionOutput ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput }
type EventSubscriptionMap ¶
type EventSubscriptionMap map[string]EventSubscriptionInput
func (EventSubscriptionMap) ElementType ¶
func (EventSubscriptionMap) ElementType() reflect.Type
func (EventSubscriptionMap) ToEventSubscriptionMapOutput ¶
func (i EventSubscriptionMap) ToEventSubscriptionMapOutput() EventSubscriptionMapOutput
func (EventSubscriptionMap) ToEventSubscriptionMapOutputWithContext ¶
func (i EventSubscriptionMap) ToEventSubscriptionMapOutputWithContext(ctx context.Context) EventSubscriptionMapOutput
type EventSubscriptionMapInput ¶
type EventSubscriptionMapInput interface { pulumi.Input ToEventSubscriptionMapOutput() EventSubscriptionMapOutput ToEventSubscriptionMapOutputWithContext(context.Context) EventSubscriptionMapOutput }
EventSubscriptionMapInput is an input type that accepts EventSubscriptionMap and EventSubscriptionMapOutput values. You can construct a concrete instance of `EventSubscriptionMapInput` via:
EventSubscriptionMap{ "key": EventSubscriptionArgs{...} }
type EventSubscriptionMapOutput ¶
type EventSubscriptionMapOutput struct{ *pulumi.OutputState }
func (EventSubscriptionMapOutput) ElementType ¶
func (EventSubscriptionMapOutput) ElementType() reflect.Type
func (EventSubscriptionMapOutput) MapIndex ¶
func (o EventSubscriptionMapOutput) MapIndex(k pulumi.StringInput) EventSubscriptionOutput
func (EventSubscriptionMapOutput) ToEventSubscriptionMapOutput ¶
func (o EventSubscriptionMapOutput) ToEventSubscriptionMapOutput() EventSubscriptionMapOutput
func (EventSubscriptionMapOutput) ToEventSubscriptionMapOutputWithContext ¶
func (o EventSubscriptionMapOutput) ToEventSubscriptionMapOutputWithContext(ctx context.Context) EventSubscriptionMapOutput
type EventSubscriptionOutput ¶
type EventSubscriptionOutput struct{ *pulumi.OutputState }
func (EventSubscriptionOutput) Arn ¶
func (o EventSubscriptionOutput) Arn() pulumi.StringOutput
The Amazon Resource Name of the Neptune event notification subscription.
func (EventSubscriptionOutput) CustomerAwsId ¶
func (o EventSubscriptionOutput) CustomerAwsId() pulumi.StringOutput
The AWS customer account associated with the Neptune event notification subscription.
func (EventSubscriptionOutput) ElementType ¶
func (EventSubscriptionOutput) ElementType() reflect.Type
func (EventSubscriptionOutput) Enabled ¶
func (o EventSubscriptionOutput) Enabled() pulumi.BoolPtrOutput
A boolean flag to enable/disable the subscription. Defaults to true.
func (EventSubscriptionOutput) EventCategories ¶
func (o EventSubscriptionOutput) EventCategories() pulumi.StringArrayOutput
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.
func (EventSubscriptionOutput) Name ¶
func (o EventSubscriptionOutput) Name() pulumi.StringOutput
The name of the Neptune event subscription. By default generated by this provider.
func (EventSubscriptionOutput) NamePrefix ¶
func (o EventSubscriptionOutput) NamePrefix() pulumi.StringOutput
The name of the Neptune event subscription. Conflicts with `name`.
func (EventSubscriptionOutput) SnsTopicArn ¶
func (o EventSubscriptionOutput) SnsTopicArn() pulumi.StringOutput
The ARN of the SNS topic to send events to.
func (EventSubscriptionOutput) SourceIds ¶
func (o EventSubscriptionOutput) SourceIds() pulumi.StringArrayOutput
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.
func (EventSubscriptionOutput) SourceType ¶
func (o EventSubscriptionOutput) SourceType() pulumi.StringPtrOutput
The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster` or `db-cluster-snapshot`. If not set, all sources will be subscribed to.
func (EventSubscriptionOutput) Tags ¶
func (o EventSubscriptionOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (EventSubscriptionOutput) TagsAll
deprecated
func (o EventSubscriptionOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (EventSubscriptionOutput) ToEventSubscriptionOutput ¶
func (o EventSubscriptionOutput) ToEventSubscriptionOutput() EventSubscriptionOutput
func (EventSubscriptionOutput) ToEventSubscriptionOutputWithContext ¶
func (o EventSubscriptionOutput) ToEventSubscriptionOutputWithContext(ctx context.Context) EventSubscriptionOutput
type EventSubscriptionState ¶
type EventSubscriptionState struct { // The Amazon Resource Name of the Neptune event notification subscription. Arn pulumi.StringPtrInput // The AWS customer account associated with the Neptune event notification subscription. 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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (EventSubscriptionState) ElementType ¶
func (EventSubscriptionState) ElementType() reflect.Type
type GetEngineVersionArgs ¶
type GetEngineVersionArgs struct { // DB engine. (Default: `neptune`) Engine *string `pulumi:"engine"` // 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 GetEngineVersionOutputArgs ¶
type GetEngineVersionOutputArgs struct { // DB engine. (Default: `neptune`) Engine pulumi.StringPtrInput `pulumi:"engine"` // Name of a specific DB parameter group family. An example parameter group family is `neptune1`. ParameterGroupFamily pulumi.StringPtrInput `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 pulumi.StringArrayInput `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 pulumi.StringPtrInput `pulumi:"version"` }
A collection of arguments for invoking getEngineVersion.
func (GetEngineVersionOutputArgs) ElementType ¶
func (GetEngineVersionOutputArgs) ElementType() reflect.Type
type GetEngineVersionResult ¶
type GetEngineVersionResult struct { Engine *string `pulumi:"engine"` // 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"` // Description of the database engine version. VersionDescription string `pulumi:"versionDescription"` }
A collection of values returned by getEngineVersion.
func GetEngineVersion ¶
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/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/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 GetEngineVersionResultOutput ¶
type GetEngineVersionResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getEngineVersion.
func GetEngineVersionOutput ¶
func GetEngineVersionOutput(ctx *pulumi.Context, args GetEngineVersionOutputArgs, opts ...pulumi.InvokeOption) GetEngineVersionResultOutput
func (GetEngineVersionResultOutput) ElementType ¶
func (GetEngineVersionResultOutput) ElementType() reflect.Type
func (GetEngineVersionResultOutput) Engine ¶
func (o GetEngineVersionResultOutput) Engine() pulumi.StringPtrOutput
func (GetEngineVersionResultOutput) EngineDescription ¶
func (o GetEngineVersionResultOutput) EngineDescription() pulumi.StringOutput
Description of the database engine.
func (GetEngineVersionResultOutput) ExportableLogTypes ¶
func (o GetEngineVersionResultOutput) ExportableLogTypes() pulumi.StringArrayOutput
Set of log types that the database engine has available for export to CloudWatch Logs.
func (GetEngineVersionResultOutput) Id ¶
func (o GetEngineVersionResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetEngineVersionResultOutput) ParameterGroupFamily ¶
func (o GetEngineVersionResultOutput) ParameterGroupFamily() pulumi.StringOutput
func (GetEngineVersionResultOutput) PreferredVersions ¶
func (o GetEngineVersionResultOutput) PreferredVersions() pulumi.StringArrayOutput
func (GetEngineVersionResultOutput) SupportedTimezones ¶
func (o GetEngineVersionResultOutput) SupportedTimezones() pulumi.StringArrayOutput
Set of the time zones supported by this engine.
func (GetEngineVersionResultOutput) SupportsLogExportsToCloudwatch ¶
func (o GetEngineVersionResultOutput) SupportsLogExportsToCloudwatch() pulumi.BoolOutput
Indicates whether the engine version supports exporting the log types specified by `exportableLogTypes` to CloudWatch Logs.
func (GetEngineVersionResultOutput) SupportsReadReplica ¶
func (o GetEngineVersionResultOutput) SupportsReadReplica() pulumi.BoolOutput
Indicates whether the database engine version supports read replicas.
func (GetEngineVersionResultOutput) ToGetEngineVersionResultOutput ¶
func (o GetEngineVersionResultOutput) ToGetEngineVersionResultOutput() GetEngineVersionResultOutput
func (GetEngineVersionResultOutput) ToGetEngineVersionResultOutputWithContext ¶
func (o GetEngineVersionResultOutput) ToGetEngineVersionResultOutputWithContext(ctx context.Context) GetEngineVersionResultOutput
func (GetEngineVersionResultOutput) ValidUpgradeTargets ¶
func (o GetEngineVersionResultOutput) ValidUpgradeTargets() pulumi.StringArrayOutput
Set of engine versions that this database engine version can be upgraded to.
func (GetEngineVersionResultOutput) Version ¶
func (o GetEngineVersionResultOutput) Version() pulumi.StringOutput
func (GetEngineVersionResultOutput) VersionDescription ¶
func (o GetEngineVersionResultOutput) VersionDescription() pulumi.StringOutput
Description of the database engine version.
type GetOrderableDbInstanceArgs ¶
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 GetOrderableDbInstanceOutputArgs ¶
type GetOrderableDbInstanceOutputArgs struct { // DB engine. (Default: `neptune`) Engine pulumi.StringPtrInput `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 pulumi.StringPtrInput `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 pulumi.StringPtrInput `pulumi:"instanceClass"` // License model. (Default: `amazon-license`) LicenseModel pulumi.StringPtrInput `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 pulumi.StringArrayInput `pulumi:"preferredInstanceClasses"` // Enable to show only VPC offerings. Vpc pulumi.BoolPtrInput `pulumi:"vpc"` }
A collection of arguments for invoking getOrderableDbInstance.
func (GetOrderableDbInstanceOutputArgs) ElementType ¶
func (GetOrderableDbInstanceOutputArgs) ElementType() reflect.Type
type GetOrderableDbInstanceResult ¶
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"` // 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 ¶
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/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.GetOrderableDbInstance(ctx, &neptune.GetOrderableDbInstanceArgs{ EngineVersion: pulumi.StringRef("1.0.3.0"), PreferredInstanceClasses: []string{ "db.r5.large", "db.r4.large", "db.t3.medium", }, }, nil) if err != nil { return err } return nil }) }
```
type GetOrderableDbInstanceResultOutput ¶
type GetOrderableDbInstanceResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getOrderableDbInstance.
func GetOrderableDbInstanceOutput ¶
func GetOrderableDbInstanceOutput(ctx *pulumi.Context, args GetOrderableDbInstanceOutputArgs, opts ...pulumi.InvokeOption) GetOrderableDbInstanceResultOutput
func (GetOrderableDbInstanceResultOutput) AvailabilityZones ¶
func (o GetOrderableDbInstanceResultOutput) AvailabilityZones() pulumi.StringArrayOutput
Availability zones where the instance is available.
func (GetOrderableDbInstanceResultOutput) ElementType ¶
func (GetOrderableDbInstanceResultOutput) ElementType() reflect.Type
func (GetOrderableDbInstanceResultOutput) Engine ¶
func (o GetOrderableDbInstanceResultOutput) Engine() pulumi.StringPtrOutput
func (GetOrderableDbInstanceResultOutput) EngineVersion ¶
func (o GetOrderableDbInstanceResultOutput) EngineVersion() pulumi.StringOutput
func (GetOrderableDbInstanceResultOutput) Id ¶
func (o GetOrderableDbInstanceResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetOrderableDbInstanceResultOutput) InstanceClass ¶
func (o GetOrderableDbInstanceResultOutput) InstanceClass() pulumi.StringOutput
func (GetOrderableDbInstanceResultOutput) LicenseModel ¶
func (o GetOrderableDbInstanceResultOutput) LicenseModel() pulumi.StringPtrOutput
func (GetOrderableDbInstanceResultOutput) MaxIopsPerDbInstance ¶
func (o GetOrderableDbInstanceResultOutput) MaxIopsPerDbInstance() pulumi.IntOutput
Maximum total provisioned IOPS for a DB instance.
func (GetOrderableDbInstanceResultOutput) MaxIopsPerGib ¶
func (o GetOrderableDbInstanceResultOutput) MaxIopsPerGib() pulumi.Float64Output
Maximum provisioned IOPS per GiB for a DB instance.
func (GetOrderableDbInstanceResultOutput) MaxStorageSize ¶
func (o GetOrderableDbInstanceResultOutput) MaxStorageSize() pulumi.IntOutput
Maximum storage size for a DB instance.
func (GetOrderableDbInstanceResultOutput) MinIopsPerDbInstance ¶
func (o GetOrderableDbInstanceResultOutput) MinIopsPerDbInstance() pulumi.IntOutput
Minimum total provisioned IOPS for a DB instance.
func (GetOrderableDbInstanceResultOutput) MinIopsPerGib ¶
func (o GetOrderableDbInstanceResultOutput) MinIopsPerGib() pulumi.Float64Output
Minimum provisioned IOPS per GiB for a DB instance.
func (GetOrderableDbInstanceResultOutput) MinStorageSize ¶
func (o GetOrderableDbInstanceResultOutput) MinStorageSize() pulumi.IntOutput
Minimum storage size for a DB instance.
func (GetOrderableDbInstanceResultOutput) MultiAzCapable ¶
func (o GetOrderableDbInstanceResultOutput) MultiAzCapable() pulumi.BoolOutput
Whether a DB instance is Multi-AZ capable.
func (GetOrderableDbInstanceResultOutput) PreferredInstanceClasses ¶
func (o GetOrderableDbInstanceResultOutput) PreferredInstanceClasses() pulumi.StringArrayOutput
func (GetOrderableDbInstanceResultOutput) ReadReplicaCapable ¶
func (o GetOrderableDbInstanceResultOutput) ReadReplicaCapable() pulumi.BoolOutput
Whether a DB instance can have a read replica.
func (GetOrderableDbInstanceResultOutput) StorageType ¶
func (o GetOrderableDbInstanceResultOutput) StorageType() pulumi.StringOutput
Storage type for a DB instance.
func (GetOrderableDbInstanceResultOutput) SupportsEnhancedMonitoring ¶
func (o GetOrderableDbInstanceResultOutput) SupportsEnhancedMonitoring() pulumi.BoolOutput
Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
func (GetOrderableDbInstanceResultOutput) SupportsIamDatabaseAuthentication ¶
func (o GetOrderableDbInstanceResultOutput) SupportsIamDatabaseAuthentication() pulumi.BoolOutput
Whether a DB instance supports IAM database authentication.
func (GetOrderableDbInstanceResultOutput) SupportsIops ¶
func (o GetOrderableDbInstanceResultOutput) SupportsIops() pulumi.BoolOutput
Whether a DB instance supports provisioned IOPS.
func (GetOrderableDbInstanceResultOutput) SupportsPerformanceInsights ¶
func (o GetOrderableDbInstanceResultOutput) SupportsPerformanceInsights() pulumi.BoolOutput
Whether a DB instance supports Performance Insights.
func (GetOrderableDbInstanceResultOutput) SupportsStorageEncryption ¶
func (o GetOrderableDbInstanceResultOutput) SupportsStorageEncryption() pulumi.BoolOutput
Whether a DB instance supports encrypted storage.
func (GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutput ¶
func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutput() GetOrderableDbInstanceResultOutput
func (GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutputWithContext ¶
func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutputWithContext(ctx context.Context) GetOrderableDbInstanceResultOutput
func (GetOrderableDbInstanceResultOutput) Vpc ¶
func (o GetOrderableDbInstanceResultOutput) Vpc() pulumi.BoolOutput
type GlobalCluster ¶
type GlobalCluster struct { pulumi.CustomResourceState // Global Cluster Amazon Resource Name (ARN) Arn pulumi.StringOutput `pulumi:"arn"` // If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. DeletionProtection pulumi.BoolPtrOutput `pulumi:"deletionProtection"` // Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `sourceDbClusterIdentifier`. Engine pulumi.StringOutput `pulumi:"engine"` // Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. // * **NOTE:** Upgrading major versions is not supported. EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` // The global cluster identifier. GlobalClusterIdentifier pulumi.StringOutput `pulumi:"globalClusterIdentifier"` // Set of objects containing Global Cluster members. GlobalClusterMembers GlobalClusterGlobalClusterMemberArrayOutput `pulumi:"globalClusterMembers"` // AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. GlobalClusterResourceId pulumi.StringOutput `pulumi:"globalClusterResourceId"` // Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value. SourceDbClusterIdentifier pulumi.StringOutput `pulumi:"sourceDbClusterIdentifier"` Status pulumi.StringOutput `pulumi:"status"` // Specifies whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided. StorageEncrypted pulumi.BoolOutput `pulumi:"storageEncrypted"` }
Manages a Neptune Global Cluster. A global cluster consists of one primary region and up to five read-only secondary regions. You issue write operations directly to the primary cluster in the primary region and Amazon Neptune automatically replicates the data to the secondary regions using dedicated infrastructure.
More information about Neptune Global Clusters can be found in the [Neptune User Guide](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-global-database.html).
## Example Usage
### New Neptune Global Cluster
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := neptune.NewGlobalCluster(ctx, "example", &neptune.GlobalClusterArgs{ GlobalClusterIdentifier: pulumi.String("global-test"), Engine: pulumi.String("neptune"), EngineVersion: pulumi.String("1.2.0.0"), }) if err != nil { return err } primary, err := neptune.NewCluster(ctx, "primary", &neptune.ClusterArgs{ Engine: example.Engine, EngineVersion: example.EngineVersion, ClusterIdentifier: pulumi.String("test-primary-cluster"), GlobalClusterIdentifier: example.ID(), NeptuneSubnetGroupName: pulumi.String("default"), }) if err != nil { return err } primaryClusterInstance, err := neptune.NewClusterInstance(ctx, "primary", &neptune.ClusterInstanceArgs{ Engine: example.Engine, EngineVersion: example.EngineVersion, Identifier: pulumi.String("test-primary-cluster-instance"), ClusterIdentifier: primary.ID(), InstanceClass: pulumi.String("db.r5.large"), NeptuneSubnetGroupName: pulumi.String("default"), }) if err != nil { return err } secondary, err := neptune.NewCluster(ctx, "secondary", &neptune.ClusterArgs{ Engine: example.Engine, EngineVersion: example.EngineVersion, ClusterIdentifier: pulumi.String("test-secondary-cluster"), GlobalClusterIdentifier: example.ID(), NeptuneSubnetGroupName: pulumi.String("default"), }) if err != nil { return err } _, err = neptune.NewClusterInstance(ctx, "secondary", &neptune.ClusterInstanceArgs{ Engine: example.Engine, EngineVersion: example.EngineVersion, Identifier: pulumi.String("test-secondary-cluster-instance"), ClusterIdentifier: secondary.ID(), InstanceClass: pulumi.String("db.r5.large"), NeptuneSubnetGroupName: pulumi.String("default"), }, pulumi.DependsOn([]pulumi.Resource{ primaryClusterInstance, })) if err != nil { return err } return nil }) }
```
### New Global Cluster From Existing DB Cluster
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := neptune.NewCluster(ctx, "example", nil) if err != nil { return err } _, err = neptune.NewGlobalCluster(ctx, "example", &neptune.GlobalClusterArgs{ GlobalClusterIdentifier: pulumi.String("example"), SourceDbClusterIdentifier: example.Arn, }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import `aws_neptune_global_cluster` using the Global Cluster identifier. For example:
```sh $ pulumi import aws:neptune/globalCluster:GlobalCluster example example ``` Certain resource arguments, like `source_db_cluster_identifier`, do not have an API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use `ignore_changes` to hide the difference. For example:
func GetGlobalCluster ¶
func GetGlobalCluster(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GlobalClusterState, opts ...pulumi.ResourceOption) (*GlobalCluster, error)
GetGlobalCluster gets an existing GlobalCluster 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 NewGlobalCluster ¶
func NewGlobalCluster(ctx *pulumi.Context, name string, args *GlobalClusterArgs, opts ...pulumi.ResourceOption) (*GlobalCluster, error)
NewGlobalCluster registers a new resource with the given unique name, arguments, and options.
func (*GlobalCluster) ElementType ¶
func (*GlobalCluster) ElementType() reflect.Type
func (*GlobalCluster) ToGlobalClusterOutput ¶
func (i *GlobalCluster) ToGlobalClusterOutput() GlobalClusterOutput
func (*GlobalCluster) ToGlobalClusterOutputWithContext ¶
func (i *GlobalCluster) ToGlobalClusterOutputWithContext(ctx context.Context) GlobalClusterOutput
type GlobalClusterArgs ¶
type GlobalClusterArgs struct { // If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. DeletionProtection pulumi.BoolPtrInput // Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `sourceDbClusterIdentifier`. Engine pulumi.StringPtrInput // Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. // * **NOTE:** Upgrading major versions is not supported. EngineVersion pulumi.StringPtrInput // The global cluster identifier. GlobalClusterIdentifier pulumi.StringInput // Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value. SourceDbClusterIdentifier pulumi.StringPtrInput // Specifies whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided. StorageEncrypted pulumi.BoolPtrInput }
The set of arguments for constructing a GlobalCluster resource.
func (GlobalClusterArgs) ElementType ¶
func (GlobalClusterArgs) ElementType() reflect.Type
type GlobalClusterArray ¶
type GlobalClusterArray []GlobalClusterInput
func (GlobalClusterArray) ElementType ¶
func (GlobalClusterArray) ElementType() reflect.Type
func (GlobalClusterArray) ToGlobalClusterArrayOutput ¶
func (i GlobalClusterArray) ToGlobalClusterArrayOutput() GlobalClusterArrayOutput
func (GlobalClusterArray) ToGlobalClusterArrayOutputWithContext ¶
func (i GlobalClusterArray) ToGlobalClusterArrayOutputWithContext(ctx context.Context) GlobalClusterArrayOutput
type GlobalClusterArrayInput ¶
type GlobalClusterArrayInput interface { pulumi.Input ToGlobalClusterArrayOutput() GlobalClusterArrayOutput ToGlobalClusterArrayOutputWithContext(context.Context) GlobalClusterArrayOutput }
GlobalClusterArrayInput is an input type that accepts GlobalClusterArray and GlobalClusterArrayOutput values. You can construct a concrete instance of `GlobalClusterArrayInput` via:
GlobalClusterArray{ GlobalClusterArgs{...} }
type GlobalClusterArrayOutput ¶
type GlobalClusterArrayOutput struct{ *pulumi.OutputState }
func (GlobalClusterArrayOutput) ElementType ¶
func (GlobalClusterArrayOutput) ElementType() reflect.Type
func (GlobalClusterArrayOutput) Index ¶
func (o GlobalClusterArrayOutput) Index(i pulumi.IntInput) GlobalClusterOutput
func (GlobalClusterArrayOutput) ToGlobalClusterArrayOutput ¶
func (o GlobalClusterArrayOutput) ToGlobalClusterArrayOutput() GlobalClusterArrayOutput
func (GlobalClusterArrayOutput) ToGlobalClusterArrayOutputWithContext ¶
func (o GlobalClusterArrayOutput) ToGlobalClusterArrayOutputWithContext(ctx context.Context) GlobalClusterArrayOutput
type GlobalClusterGlobalClusterMemberArgs ¶
type GlobalClusterGlobalClusterMemberArgs struct { // Amazon Resource Name (ARN) of member DB Cluster. DbClusterArn pulumi.StringPtrInput `pulumi:"dbClusterArn"` // Whether the member is the primary DB Cluster. IsWriter pulumi.BoolPtrInput `pulumi:"isWriter"` }
func (GlobalClusterGlobalClusterMemberArgs) ElementType ¶
func (GlobalClusterGlobalClusterMemberArgs) ElementType() reflect.Type
func (GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutput ¶
func (i GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutput() GlobalClusterGlobalClusterMemberOutput
func (GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutputWithContext ¶
func (i GlobalClusterGlobalClusterMemberArgs) ToGlobalClusterGlobalClusterMemberOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberOutput
type GlobalClusterGlobalClusterMemberArray ¶
type GlobalClusterGlobalClusterMemberArray []GlobalClusterGlobalClusterMemberInput
func (GlobalClusterGlobalClusterMemberArray) ElementType ¶
func (GlobalClusterGlobalClusterMemberArray) ElementType() reflect.Type
func (GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutput ¶
func (i GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutput() GlobalClusterGlobalClusterMemberArrayOutput
func (GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext ¶
func (i GlobalClusterGlobalClusterMemberArray) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberArrayOutput
type GlobalClusterGlobalClusterMemberArrayInput ¶
type GlobalClusterGlobalClusterMemberArrayInput interface { pulumi.Input ToGlobalClusterGlobalClusterMemberArrayOutput() GlobalClusterGlobalClusterMemberArrayOutput ToGlobalClusterGlobalClusterMemberArrayOutputWithContext(context.Context) GlobalClusterGlobalClusterMemberArrayOutput }
GlobalClusterGlobalClusterMemberArrayInput is an input type that accepts GlobalClusterGlobalClusterMemberArray and GlobalClusterGlobalClusterMemberArrayOutput values. You can construct a concrete instance of `GlobalClusterGlobalClusterMemberArrayInput` via:
GlobalClusterGlobalClusterMemberArray{ GlobalClusterGlobalClusterMemberArgs{...} }
type GlobalClusterGlobalClusterMemberArrayOutput ¶
type GlobalClusterGlobalClusterMemberArrayOutput struct{ *pulumi.OutputState }
func (GlobalClusterGlobalClusterMemberArrayOutput) ElementType ¶
func (GlobalClusterGlobalClusterMemberArrayOutput) ElementType() reflect.Type
func (GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutput ¶
func (o GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutput() GlobalClusterGlobalClusterMemberArrayOutput
func (GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext ¶
func (o GlobalClusterGlobalClusterMemberArrayOutput) ToGlobalClusterGlobalClusterMemberArrayOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberArrayOutput
type GlobalClusterGlobalClusterMemberInput ¶
type GlobalClusterGlobalClusterMemberInput interface { pulumi.Input ToGlobalClusterGlobalClusterMemberOutput() GlobalClusterGlobalClusterMemberOutput ToGlobalClusterGlobalClusterMemberOutputWithContext(context.Context) GlobalClusterGlobalClusterMemberOutput }
GlobalClusterGlobalClusterMemberInput is an input type that accepts GlobalClusterGlobalClusterMemberArgs and GlobalClusterGlobalClusterMemberOutput values. You can construct a concrete instance of `GlobalClusterGlobalClusterMemberInput` via:
GlobalClusterGlobalClusterMemberArgs{...}
type GlobalClusterGlobalClusterMemberOutput ¶
type GlobalClusterGlobalClusterMemberOutput struct{ *pulumi.OutputState }
func (GlobalClusterGlobalClusterMemberOutput) DbClusterArn ¶
func (o GlobalClusterGlobalClusterMemberOutput) DbClusterArn() pulumi.StringPtrOutput
Amazon Resource Name (ARN) of member DB Cluster.
func (GlobalClusterGlobalClusterMemberOutput) ElementType ¶
func (GlobalClusterGlobalClusterMemberOutput) ElementType() reflect.Type
func (GlobalClusterGlobalClusterMemberOutput) IsWriter ¶
func (o GlobalClusterGlobalClusterMemberOutput) IsWriter() pulumi.BoolPtrOutput
Whether the member is the primary DB Cluster.
func (GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutput ¶
func (o GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutput() GlobalClusterGlobalClusterMemberOutput
func (GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutputWithContext ¶
func (o GlobalClusterGlobalClusterMemberOutput) ToGlobalClusterGlobalClusterMemberOutputWithContext(ctx context.Context) GlobalClusterGlobalClusterMemberOutput
type GlobalClusterInput ¶
type GlobalClusterInput interface { pulumi.Input ToGlobalClusterOutput() GlobalClusterOutput ToGlobalClusterOutputWithContext(ctx context.Context) GlobalClusterOutput }
type GlobalClusterMap ¶
type GlobalClusterMap map[string]GlobalClusterInput
func (GlobalClusterMap) ElementType ¶
func (GlobalClusterMap) ElementType() reflect.Type
func (GlobalClusterMap) ToGlobalClusterMapOutput ¶
func (i GlobalClusterMap) ToGlobalClusterMapOutput() GlobalClusterMapOutput
func (GlobalClusterMap) ToGlobalClusterMapOutputWithContext ¶
func (i GlobalClusterMap) ToGlobalClusterMapOutputWithContext(ctx context.Context) GlobalClusterMapOutput
type GlobalClusterMapInput ¶
type GlobalClusterMapInput interface { pulumi.Input ToGlobalClusterMapOutput() GlobalClusterMapOutput ToGlobalClusterMapOutputWithContext(context.Context) GlobalClusterMapOutput }
GlobalClusterMapInput is an input type that accepts GlobalClusterMap and GlobalClusterMapOutput values. You can construct a concrete instance of `GlobalClusterMapInput` via:
GlobalClusterMap{ "key": GlobalClusterArgs{...} }
type GlobalClusterMapOutput ¶
type GlobalClusterMapOutput struct{ *pulumi.OutputState }
func (GlobalClusterMapOutput) ElementType ¶
func (GlobalClusterMapOutput) ElementType() reflect.Type
func (GlobalClusterMapOutput) MapIndex ¶
func (o GlobalClusterMapOutput) MapIndex(k pulumi.StringInput) GlobalClusterOutput
func (GlobalClusterMapOutput) ToGlobalClusterMapOutput ¶
func (o GlobalClusterMapOutput) ToGlobalClusterMapOutput() GlobalClusterMapOutput
func (GlobalClusterMapOutput) ToGlobalClusterMapOutputWithContext ¶
func (o GlobalClusterMapOutput) ToGlobalClusterMapOutputWithContext(ctx context.Context) GlobalClusterMapOutput
type GlobalClusterOutput ¶
type GlobalClusterOutput struct{ *pulumi.OutputState }
func (GlobalClusterOutput) Arn ¶
func (o GlobalClusterOutput) Arn() pulumi.StringOutput
Global Cluster Amazon Resource Name (ARN)
func (GlobalClusterOutput) DeletionProtection ¶
func (o GlobalClusterOutput) DeletionProtection() pulumi.BoolPtrOutput
If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`.
func (GlobalClusterOutput) ElementType ¶
func (GlobalClusterOutput) ElementType() reflect.Type
func (GlobalClusterOutput) Engine ¶
func (o GlobalClusterOutput) Engine() pulumi.StringOutput
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `sourceDbClusterIdentifier`.
func (GlobalClusterOutput) EngineVersion ¶
func (o GlobalClusterOutput) EngineVersion() pulumi.StringOutput
Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. * **NOTE:** Upgrading major versions is not supported.
func (GlobalClusterOutput) GlobalClusterIdentifier ¶
func (o GlobalClusterOutput) GlobalClusterIdentifier() pulumi.StringOutput
The global cluster identifier.
func (GlobalClusterOutput) GlobalClusterMembers ¶
func (o GlobalClusterOutput) GlobalClusterMembers() GlobalClusterGlobalClusterMemberArrayOutput
Set of objects containing Global Cluster members.
func (GlobalClusterOutput) GlobalClusterResourceId ¶
func (o GlobalClusterOutput) GlobalClusterResourceId() pulumi.StringOutput
AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
func (GlobalClusterOutput) SourceDbClusterIdentifier ¶
func (o GlobalClusterOutput) SourceDbClusterIdentifier() pulumi.StringOutput
Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
func (GlobalClusterOutput) Status ¶
func (o GlobalClusterOutput) Status() pulumi.StringOutput
func (GlobalClusterOutput) StorageEncrypted ¶
func (o GlobalClusterOutput) StorageEncrypted() pulumi.BoolOutput
Specifies whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
func (GlobalClusterOutput) ToGlobalClusterOutput ¶
func (o GlobalClusterOutput) ToGlobalClusterOutput() GlobalClusterOutput
func (GlobalClusterOutput) ToGlobalClusterOutputWithContext ¶
func (o GlobalClusterOutput) ToGlobalClusterOutputWithContext(ctx context.Context) GlobalClusterOutput
type GlobalClusterState ¶
type GlobalClusterState struct { // Global Cluster Amazon Resource Name (ARN) Arn pulumi.StringPtrInput // If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. DeletionProtection pulumi.BoolPtrInput // Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `sourceDbClusterIdentifier`. Engine pulumi.StringPtrInput // Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. // * **NOTE:** Upgrading major versions is not supported. EngineVersion pulumi.StringPtrInput // The global cluster identifier. GlobalClusterIdentifier pulumi.StringPtrInput // Set of objects containing Global Cluster members. GlobalClusterMembers GlobalClusterGlobalClusterMemberArrayInput // AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. GlobalClusterResourceId pulumi.StringPtrInput // Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value. SourceDbClusterIdentifier pulumi.StringPtrInput Status pulumi.StringPtrInput // Specifies whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. The provider will only perform drift detection if a configuration value is provided. StorageEncrypted pulumi.BoolPtrInput }
func (GlobalClusterState) ElementType ¶
func (GlobalClusterState) ElementType() reflect.Type
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"` // 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 ParameterGroupParameterArrayOutput `pulumi:"parameters"` // A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Manages a Neptune Parameter Group
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewParameterGroup(ctx, "example", &neptune.ParameterGroupArgs{ Family: pulumi.String("neptune1"), Name: pulumi.String("example"), Parameters: neptune.ParameterGroupParameterArray{ &neptune.ParameterGroupParameterArgs{ Name: pulumi.String("neptune_query_timeout"), Value: pulumi.String("25"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import Neptune Parameter Groups using the `name`. For example:
```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 ¶
func (*ParameterGroup) ElementType() reflect.Type
func (*ParameterGroup) ToParameterGroupOutput ¶
func (i *ParameterGroup) ToParameterGroupOutput() ParameterGroupOutput
func (*ParameterGroup) ToParameterGroupOutputWithContext ¶
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 // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of Neptune parameters to apply. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a ParameterGroup resource.
func (ParameterGroupArgs) ElementType ¶
func (ParameterGroupArgs) ElementType() reflect.Type
type ParameterGroupArray ¶
type ParameterGroupArray []ParameterGroupInput
func (ParameterGroupArray) ElementType ¶
func (ParameterGroupArray) ElementType() reflect.Type
func (ParameterGroupArray) ToParameterGroupArrayOutput ¶
func (i ParameterGroupArray) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
func (ParameterGroupArray) ToParameterGroupArrayOutputWithContext ¶
func (i ParameterGroupArray) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
type ParameterGroupArrayInput ¶
type ParameterGroupArrayInput interface { pulumi.Input ToParameterGroupArrayOutput() ParameterGroupArrayOutput ToParameterGroupArrayOutputWithContext(context.Context) ParameterGroupArrayOutput }
ParameterGroupArrayInput is an input type that accepts ParameterGroupArray and ParameterGroupArrayOutput values. You can construct a concrete instance of `ParameterGroupArrayInput` via:
ParameterGroupArray{ ParameterGroupArgs{...} }
type ParameterGroupArrayOutput ¶
type ParameterGroupArrayOutput struct{ *pulumi.OutputState }
func (ParameterGroupArrayOutput) ElementType ¶
func (ParameterGroupArrayOutput) ElementType() reflect.Type
func (ParameterGroupArrayOutput) Index ¶
func (o ParameterGroupArrayOutput) Index(i pulumi.IntInput) ParameterGroupOutput
func (ParameterGroupArrayOutput) ToParameterGroupArrayOutput ¶
func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
func (ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext ¶
func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
type ParameterGroupInput ¶
type ParameterGroupInput interface { pulumi.Input ToParameterGroupOutput() ParameterGroupOutput ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput }
type ParameterGroupMap ¶
type ParameterGroupMap map[string]ParameterGroupInput
func (ParameterGroupMap) ElementType ¶
func (ParameterGroupMap) ElementType() reflect.Type
func (ParameterGroupMap) ToParameterGroupMapOutput ¶
func (i ParameterGroupMap) ToParameterGroupMapOutput() ParameterGroupMapOutput
func (ParameterGroupMap) ToParameterGroupMapOutputWithContext ¶
func (i ParameterGroupMap) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
type ParameterGroupMapInput ¶
type ParameterGroupMapInput interface { pulumi.Input ToParameterGroupMapOutput() ParameterGroupMapOutput ToParameterGroupMapOutputWithContext(context.Context) ParameterGroupMapOutput }
ParameterGroupMapInput is an input type that accepts ParameterGroupMap and ParameterGroupMapOutput values. You can construct a concrete instance of `ParameterGroupMapInput` via:
ParameterGroupMap{ "key": ParameterGroupArgs{...} }
type ParameterGroupMapOutput ¶
type ParameterGroupMapOutput struct{ *pulumi.OutputState }
func (ParameterGroupMapOutput) ElementType ¶
func (ParameterGroupMapOutput) ElementType() reflect.Type
func (ParameterGroupMapOutput) MapIndex ¶
func (o ParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ParameterGroupOutput
func (ParameterGroupMapOutput) ToParameterGroupMapOutput ¶
func (o ParameterGroupMapOutput) ToParameterGroupMapOutput() ParameterGroupMapOutput
func (ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext ¶
func (o ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
type ParameterGroupOutput ¶
type ParameterGroupOutput struct{ *pulumi.OutputState }
func (ParameterGroupOutput) Arn ¶
func (o ParameterGroupOutput) Arn() pulumi.StringOutput
The Neptune parameter group Amazon Resource Name (ARN).
func (ParameterGroupOutput) Description ¶
func (o ParameterGroupOutput) Description() pulumi.StringPtrOutput
The description of the Neptune parameter group. Defaults to "Managed by Pulumi".
func (ParameterGroupOutput) ElementType ¶
func (ParameterGroupOutput) ElementType() reflect.Type
func (ParameterGroupOutput) Family ¶
func (o ParameterGroupOutput) Family() pulumi.StringOutput
The family of the Neptune parameter group.
func (ParameterGroupOutput) Name ¶
func (o ParameterGroupOutput) Name() pulumi.StringOutput
The name of the Neptune parameter.
func (ParameterGroupOutput) NamePrefix ¶ added in v6.13.0
func (o ParameterGroupOutput) NamePrefix() pulumi.StringOutput
Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (ParameterGroupOutput) Parameters ¶
func (o ParameterGroupOutput) Parameters() ParameterGroupParameterArrayOutput
A list of Neptune parameters to apply.
func (ParameterGroupOutput) Tags ¶
func (o ParameterGroupOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (ParameterGroupOutput) TagsAll
deprecated
func (o ParameterGroupOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (ParameterGroupOutput) ToParameterGroupOutput ¶
func (o ParameterGroupOutput) ToParameterGroupOutput() ParameterGroupOutput
func (ParameterGroupOutput) ToParameterGroupOutputWithContext ¶
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 // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A list of Neptune parameters to apply. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll 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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides an Neptune subnet group resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := neptune.NewSubnetGroup(ctx, "default", &neptune.SubnetGroupArgs{ Name: pulumi.String("main"), SubnetIds: pulumi.StringArray{ frontend.Id, backend.Id, }, Tags: pulumi.StringMap{ "Name": pulumi.String("My neptune subnet group"), }, }) if err != nil { return err } return nil }) }
```
## Import
Using `pulumi import`, import Neptune Subnet groups using the `name`. For example:
```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 ¶
func (*SubnetGroup) ElementType() reflect.Type
func (*SubnetGroup) ToSubnetGroupOutput ¶
func (i *SubnetGroup) ToSubnetGroupOutput() SubnetGroupOutput
func (*SubnetGroup) ToSubnetGroupOutputWithContext ¶
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput }
The set of arguments for constructing a SubnetGroup resource.
func (SubnetGroupArgs) ElementType ¶
func (SubnetGroupArgs) ElementType() reflect.Type
type SubnetGroupArray ¶
type SubnetGroupArray []SubnetGroupInput
func (SubnetGroupArray) ElementType ¶
func (SubnetGroupArray) ElementType() reflect.Type
func (SubnetGroupArray) ToSubnetGroupArrayOutput ¶
func (i SubnetGroupArray) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
func (SubnetGroupArray) ToSubnetGroupArrayOutputWithContext ¶
func (i SubnetGroupArray) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
type SubnetGroupArrayInput ¶
type SubnetGroupArrayInput interface { pulumi.Input ToSubnetGroupArrayOutput() SubnetGroupArrayOutput ToSubnetGroupArrayOutputWithContext(context.Context) SubnetGroupArrayOutput }
SubnetGroupArrayInput is an input type that accepts SubnetGroupArray and SubnetGroupArrayOutput values. You can construct a concrete instance of `SubnetGroupArrayInput` via:
SubnetGroupArray{ SubnetGroupArgs{...} }
type SubnetGroupArrayOutput ¶
type SubnetGroupArrayOutput struct{ *pulumi.OutputState }
func (SubnetGroupArrayOutput) ElementType ¶
func (SubnetGroupArrayOutput) ElementType() reflect.Type
func (SubnetGroupArrayOutput) Index ¶
func (o SubnetGroupArrayOutput) Index(i pulumi.IntInput) SubnetGroupOutput
func (SubnetGroupArrayOutput) ToSubnetGroupArrayOutput ¶
func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
func (SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext ¶
func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
type SubnetGroupInput ¶
type SubnetGroupInput interface { pulumi.Input ToSubnetGroupOutput() SubnetGroupOutput ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput }
type SubnetGroupMap ¶
type SubnetGroupMap map[string]SubnetGroupInput
func (SubnetGroupMap) ElementType ¶
func (SubnetGroupMap) ElementType() reflect.Type
func (SubnetGroupMap) ToSubnetGroupMapOutput ¶
func (i SubnetGroupMap) ToSubnetGroupMapOutput() SubnetGroupMapOutput
func (SubnetGroupMap) ToSubnetGroupMapOutputWithContext ¶
func (i SubnetGroupMap) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
type SubnetGroupMapInput ¶
type SubnetGroupMapInput interface { pulumi.Input ToSubnetGroupMapOutput() SubnetGroupMapOutput ToSubnetGroupMapOutputWithContext(context.Context) SubnetGroupMapOutput }
SubnetGroupMapInput is an input type that accepts SubnetGroupMap and SubnetGroupMapOutput values. You can construct a concrete instance of `SubnetGroupMapInput` via:
SubnetGroupMap{ "key": SubnetGroupArgs{...} }
type SubnetGroupMapOutput ¶
type SubnetGroupMapOutput struct{ *pulumi.OutputState }
func (SubnetGroupMapOutput) ElementType ¶
func (SubnetGroupMapOutput) ElementType() reflect.Type
func (SubnetGroupMapOutput) MapIndex ¶
func (o SubnetGroupMapOutput) MapIndex(k pulumi.StringInput) SubnetGroupOutput
func (SubnetGroupMapOutput) ToSubnetGroupMapOutput ¶
func (o SubnetGroupMapOutput) ToSubnetGroupMapOutput() SubnetGroupMapOutput
func (SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext ¶
func (o SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
type SubnetGroupOutput ¶
type SubnetGroupOutput struct{ *pulumi.OutputState }
func (SubnetGroupOutput) Arn ¶
func (o SubnetGroupOutput) Arn() pulumi.StringOutput
The ARN of the neptune subnet group.
func (SubnetGroupOutput) Description ¶
func (o SubnetGroupOutput) Description() pulumi.StringOutput
The description of the neptune subnet group. Defaults to "Managed by Pulumi".
func (SubnetGroupOutput) ElementType ¶
func (SubnetGroupOutput) ElementType() reflect.Type
func (SubnetGroupOutput) Name ¶
func (o SubnetGroupOutput) Name() pulumi.StringOutput
The name of the neptune subnet group. If omitted, this provider will assign a random, unique name.
func (SubnetGroupOutput) NamePrefix ¶
func (o SubnetGroupOutput) NamePrefix() pulumi.StringOutput
Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (SubnetGroupOutput) SubnetIds ¶
func (o SubnetGroupOutput) SubnetIds() pulumi.StringArrayOutput
A list of VPC subnet IDs.
func (SubnetGroupOutput) Tags ¶
func (o SubnetGroupOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (SubnetGroupOutput) TagsAll
deprecated
func (o SubnetGroupOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
Deprecated: Please use `tags` instead.
func (SubnetGroupOutput) ToSubnetGroupOutput ¶
func (o SubnetGroupOutput) ToSubnetGroupOutput() SubnetGroupOutput
func (SubnetGroupOutput) ToSubnetGroupOutputWithContext ¶
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. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. // // Deprecated: Please use `tags` instead. TagsAll pulumi.StringMapInput }
func (SubnetGroupState) ElementType ¶
func (SubnetGroupState) ElementType() reflect.Type