software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neptune-alpha Show documentation
The CDK Construct Library for AWS::Neptune
There is a newer version: 2.168.0-alpha.0
package software.amazon.awscdk.services.neptune.alpha;

/**
 * (experimental) A cluster parameter group.
 * 
 * Example:
 * 

 * 
 * ClusterParameterGroup clusterParams = ClusterParameterGroup.Builder.create(this, "ClusterParams")
 *         .description("Cluster parameter group")
 *         .parameters(Map.of(
 *                 "neptune_enable_audit_log", "1"))
 *         .build();
 * ParameterGroup dbParams = ParameterGroup.Builder.create(this, "DbParams")
 *         .description("Db parameter group")
 *         .parameters(Map.of(
 *                 "neptune_query_timeout", "120000"))
 *         .build();
 * DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
 *         .vpc(vpc)
 *         .instanceType(InstanceType.R5_LARGE)
 *         .clusterParameterGroup(clusterParams)
 *         .parameterGroup(dbParams)
 *         .build();
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.54.0 (build b1b977a)", date = "2022-02-25T01:49:27.812Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.neptune.alpha.$Module.class, fqn = "@aws-cdk/aws-neptune-alpha.ClusterParameterGroup")
public class ClusterParameterGroup extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.neptune.alpha.IClusterParameterGroup {

    protected ClusterParameterGroup(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected ClusterParameterGroup(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param scope This parameter is required.
     * @param id This parameter is required.
     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public ClusterParameterGroup(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroupProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * (experimental) Imports a parameter group.
     * 
     * @param scope This parameter is required.
     * @param id This parameter is required.
     * @param clusterParameterGroupName This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.neptune.alpha.IClusterParameterGroup fromClusterParameterGroupName(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String clusterParameterGroupName) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup.class, "fromClusterParameterGroupName", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.neptune.alpha.IClusterParameterGroup.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(clusterParameterGroupName, "clusterParameterGroupName is required") });
    }

    /**
     * (experimental) The name of the parameter group.
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull java.lang.String getClusterParameterGroupName() {
        return software.amazon.jsii.Kernel.get(this, "clusterParameterGroupName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * (experimental) A fluent builder for {@link software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup}.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public static final class Builder implements software.amazon.jsii.Builder {
        /**
         * @return a new instance of {@link Builder}.
         * @param scope This parameter is required.
         * @param id This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
            return new Builder(scope, id);
        }

        private final software.constructs.Construct scope;
        private final java.lang.String id;
        private final software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroupProps.Builder props;

        private Builder(final software.constructs.Construct scope, final java.lang.String id) {
            this.scope = scope;
            this.id = id;
            this.props = new software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroupProps.Builder();
        }

        /**
         * (experimental) The parameters in this parameter group.
         * 

         * @return {@code this}
         * @param parameters The parameters in this parameter group. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder parameters(final java.util.Map parameters) {
            this.props.parameters(parameters);
            return this;
        }

        /**
         * (experimental) The name of the parameter group.
         * 

         * Default: A CDK generated name for the parameter group
         * 

         * @return {@code this}
         * @param clusterParameterGroupName The name of the parameter group. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder clusterParameterGroupName(final java.lang.String clusterParameterGroupName) {
            this.props.clusterParameterGroupName(clusterParameterGroupName);
            return this;
        }

        /**
         * (experimental) Description for this parameter group.
         * 

         * Default: a CDK generated description
         * 
         * @return {@code this}
         * @param description Description for this parameter group. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder description(final java.lang.String description) {
            this.props.description(description);
            return this;
        }

        /**
         * @returns a newly built instance of {@link software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        @Override
        public software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup build() {
            return new software.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup(
                this.scope,
                this.id,
                this.props.build()
            );
        }
    }
}