software.amazon.awscdk.services.ivs.alpha.StreamKey Maven / Gradle / Ivy

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

/**
 * (experimental) A new IVS Stream Key.
 * 
 * Example:
 * 

 * 
 * StreamKey myStreamKey = myChannel.addStreamKey("StreamKey");
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T10:56:42.152Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.ivs.alpha.$Module.class, fqn = "@aws-cdk/aws-ivs-alpha.StreamKey")
public class StreamKey extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.ivs.alpha.IStreamKey {

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

    protected StreamKey(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 StreamKey(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.ivs.alpha.StreamKeyProps 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) The stream-key ARN.
     * 
     * For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull java.lang.String getStreamKeyArn() {
        return software.amazon.jsii.Kernel.get(this, "streamKeyArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * (experimental) The stream-key value.
     * 

     * For example: sk_us-west-2_abcdABCDefgh_567890abcdef
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull java.lang.String getStreamKeyValue() {
        return software.amazon.jsii.Kernel.get(this, "streamKeyValue", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * (experimental) A fluent builder for {@link software.amazon.awscdk.services.ivs.alpha.StreamKey}.
     */
    @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.ivs.alpha.StreamKeyProps.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.ivs.alpha.StreamKeyProps.Builder();
        }

        /**
         * (experimental) Channel ARN for the stream.
         * 
         * @return {@code this}
         * @param channel Channel ARN for the stream. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder channel(final software.amazon.awscdk.services.ivs.alpha.IChannel channel) {
            this.props.channel(channel);
            return this;
        }

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