software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair Maven / Gradle / Ivy
Show all versions of ivs-alpha Show documentation
package software.amazon.awscdk.services.ivs.alpha;
/**
* (experimental) A new IVS Playback Key Pair.
*
* Example:
*
*
* PlaybackKeyPair keyPair = PlaybackKeyPair.Builder.create(this, "PlaybackKeyPair")
* .publicKeyMaterial(myPublicKeyPemString)
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T10:56:42.151Z")
@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.PlaybackKeyPair")
public class PlaybackKeyPair extends software.amazon.awscdk.Resource implements software.amazon.awscdk.services.ivs.alpha.IPlaybackKeyPair {
protected PlaybackKeyPair(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected PlaybackKeyPair(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 PlaybackKeyPair(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.PlaybackKeyPairProps 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) Key-pair ARN.
*
* For example: arn:aws:ivs:us-west-2:693991300569:playback-key/f99cde61-c2b0-4df3-8941-ca7d38acca1a
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getPlaybackKeyPairArn() {
return software.amazon.jsii.Kernel.get(this, "playbackKeyPairArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) Key-pair identifier.
*
* For example: 98:0d:1a:a0:19:96:1e:ea:0a:0a:2c:9a:42:19:2b:e7
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getPlaybackKeyPairFingerprint() {
return software.amazon.jsii.Kernel.get(this, "playbackKeyPairFingerprint", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair}.
*/
@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.PlaybackKeyPairProps.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.PlaybackKeyPairProps.Builder();
}
/**
* (experimental) The public portion of a customer-generated key pair.
*
* @return {@code this}
* @param publicKeyMaterial The public portion of a customer-generated key pair. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder publicKeyMaterial(final java.lang.String publicKeyMaterial) {
this.props.publicKeyMaterial(publicKeyMaterial);
return this;
}
/**
* (experimental) An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource.
*
* The value does not need to be unique.
*
* Default: Automatically generated name
*
* @return {@code this}
* @param playbackKeyPairName An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder playbackKeyPairName(final java.lang.String playbackKeyPairName) {
this.props.playbackKeyPairName(playbackKeyPairName);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair build() {
return new software.amazon.awscdk.services.ivs.alpha.PlaybackKeyPair(
this.scope,
this.id,
this.props.build()
);
}
}
}