io.cloudshiftdev.awscdk.services.neptune.CfnDBClusterParameterGroup.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.neptune
import io.cloudshiftdev.awscdk.CfnResource
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IInspectable
import io.cloudshiftdev.awscdk.ITaggable
import io.cloudshiftdev.awscdk.TagManager
import io.cloudshiftdev.awscdk.TreeInspector
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.Any
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* The `AWS::Neptune::DBClusterParameterGroup` resource creates a new Amazon Neptune DB cluster
* parameter group.
*
*
* Applying a parameter group to a DB cluster might require instances to reboot, resulting in a
* database outage while the instances reboot. > If you provide a custom `DBClusterParameterGroup`
* that you associate with the `DBCluster` , it is best to specify an `EngineVersion` property in the
* `DBCluster` . That `EngineVersion` needs to be compatible with the value of the `Family` property in
* the `DBClusterParameterGroup` .
*
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.neptune.*;
* Object parameters;
* CfnDBClusterParameterGroup cfnDBClusterParameterGroup =
* CfnDBClusterParameterGroup.Builder.create(this, "MyCfnDBClusterParameterGroup")
* .description("description")
* .family("family")
* .parameters(parameters)
* // the properties below are optional
* .name("name")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html)
*/
public open class CfnDBClusterParameterGroup(
cdkObject: software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup,
) : CfnResource(cdkObject),
IInspectable,
ITaggable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnDBClusterParameterGroupProps,
) :
this(software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CfnDBClusterParameterGroupProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CfnDBClusterParameterGroupProps.Builder.() -> Unit,
) : this(scope, id, CfnDBClusterParameterGroupProps(props)
)
/**
*
*/
public open fun attrId(): String = unwrap(this).getAttrId()
/**
* Provides the customer-specified description for this DB cluster parameter group.
*/
public open fun description(): String = unwrap(this).getDescription()
/**
* Provides the customer-specified description for this DB cluster parameter group.
*/
public open fun description(`value`: String) {
unwrap(this).setDescription(`value`)
}
/**
* Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or
* `neptune1.2` for engine version `1.2.0.0` and higher.
*/
public open fun family(): String = unwrap(this).getFamily()
/**
* Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or
* `neptune1.2` for engine version `1.2.0.0` and higher.
*/
public open fun family(`value`: String) {
unwrap(this).setFamily(`value`)
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector tree inspector to collect and process attributes.
*/
public override fun inspect(inspector: TreeInspector) {
unwrap(this).inspect(inspector.let(TreeInspector.Companion::unwrap))
}
/**
* Provides the name of the DB cluster parameter group.
*/
public open fun name(): String? = unwrap(this).getName()
/**
* Provides the name of the DB cluster parameter group.
*/
public open fun name(`value`: String) {
unwrap(this).setName(`value`)
}
/**
* The parameters to set for this DB cluster parameter group.
*/
public open fun parameters(): Any = unwrap(this).getParameters()
/**
* The parameters to set for this DB cluster parameter group.
*/
public open fun parameters(`value`: Any) {
unwrap(this).setParameters(`value`)
}
/**
* Tag Manager which manages the tags for this resource.
*/
public override fun tags(): TagManager = unwrap(this).getTags().let(TagManager::wrap)
/**
* The tags that you want to attach to this parameter group.
*/
public open fun tagsRaw(): List = unwrap(this).getTagsRaw()?.map(CfnTag::wrap) ?:
emptyList()
/**
* The tags that you want to attach to this parameter group.
*/
public open fun tagsRaw(`value`: List) {
unwrap(this).setTagsRaw(`value`.map(CfnTag.Companion::unwrap))
}
/**
* The tags that you want to attach to this parameter group.
*/
public open fun tagsRaw(vararg `value`: CfnTag): Unit = tagsRaw(`value`.toList())
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.neptune.CfnDBClusterParameterGroup].
*/
@CdkDslMarker
public interface Builder {
/**
* Provides the customer-specified description for this DB cluster parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description)
* @param description Provides the customer-specified description for this DB cluster parameter
* group.
*/
public fun description(description: String)
/**
* Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) ,
* or `neptune1.2` for engine version `1.2.0.0` and higher.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family)
* @param family Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) ,
* or `neptune1.2` for engine version `1.2.0.0` and higher.
*/
public fun family(family: String)
/**
* Provides the name of the DB cluster parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name)
* @param name Provides the name of the DB cluster parameter group.
*/
public fun name(name: String)
/**
* The parameters to set for this DB cluster parameter group.
*
* The parameters are expressed as a JSON object consisting of key-value pairs.
*
* If you update the parameters, some interruption may occur depending on which parameters you
* update.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters)
* @param parameters The parameters to set for this DB cluster parameter group.
*/
public fun parameters(parameters: Any)
/**
* The tags that you want to attach to this parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags)
* @param tags The tags that you want to attach to this parameter group.
*/
public fun tags(tags: List)
/**
* The tags that you want to attach to this parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags)
* @param tags The tags that you want to attach to this parameter group.
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup.Builder =
software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup.Builder.create(scope, id)
/**
* Provides the customer-specified description for this DB cluster parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description)
* @param description Provides the customer-specified description for this DB cluster parameter
* group.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) ,
* or `neptune1.2` for engine version `1.2.0.0` and higher.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family)
* @param family Must be `neptune1` for engine versions prior to
* [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) ,
* or `neptune1.2` for engine version `1.2.0.0` and higher.
*/
override fun family(family: String) {
cdkBuilder.family(family)
}
/**
* Provides the name of the DB cluster parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name)
* @param name Provides the name of the DB cluster parameter group.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* The parameters to set for this DB cluster parameter group.
*
* The parameters are expressed as a JSON object consisting of key-value pairs.
*
* If you update the parameters, some interruption may occur depending on which parameters you
* update.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters)
* @param parameters The parameters to set for this DB cluster parameter group.
*/
override fun parameters(parameters: Any) {
cdkBuilder.parameters(parameters)
}
/**
* The tags that you want to attach to this parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags)
* @param tags The tags that you want to attach to this parameter group.
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* The tags that you want to attach to this parameter group.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags)
* @param tags The tags that you want to attach to this parameter group.
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup =
cdkBuilder.build()
}
public companion object {
public val CFN_RESOURCE_TYPE_NAME: String =
software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup.CFN_RESOURCE_TYPE_NAME
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CfnDBClusterParameterGroup {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CfnDBClusterParameterGroup(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup):
CfnDBClusterParameterGroup = CfnDBClusterParameterGroup(cdkObject)
internal fun unwrap(wrapped: CfnDBClusterParameterGroup):
software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup = wrapped.cdkObject as
software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy