software.amazon.awscdk.services.appsync.PartitionKeyStep Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appsync Show documentation

The CDK Construct Library for AWS::AppSync

There is a newer version: 1.204.0

package software.amazon.awscdk.services.appsync;

/**
 * (experimental) Utility class to allow assigning a value or an auto-generated id to a partition key.
 * 
 * Example:
 * 

 * 
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import software.amazon.awscdk.services.appsync.*;
 * PartitionKeyStep partitionKeyStep = new PartitionKeyStep("key");
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.72.0 (build 4b8828b)", date = "2023-01-11T14:44:52.285Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.appsync.$Module.class, fqn = "@aws-cdk/aws-appsync.PartitionKeyStep")
public class PartitionKeyStep extends software.amazon.jsii.JsiiObject {

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

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

    /**
     * @param key This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public PartitionKeyStep(final @org.jetbrains.annotations.NotNull java.lang.String key) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(key, "key is required") });
    }

    /**
     * (experimental) Assign an auto-generated value to the partition key.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appsync.PartitionKey auto() {
        return software.amazon.jsii.Kernel.call(this, "auto", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.appsync.PartitionKey.class));
    }

    /**
     * (experimental) Assign an auto-generated value to the partition key.
     * 
     * @param val This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appsync.PartitionKey is(final @org.jetbrains.annotations.NotNull java.lang.String val) {
        return software.amazon.jsii.Kernel.call(this, "is", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.appsync.PartitionKey.class), new Object[] { java.util.Objects.requireNonNull(val, "val is required") });
    }
}