Package software.amazon.awscdk.services.ivs

Interface CfnPublicKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPublicKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:12.938Z")
@Stability(Stable)
public interface CfnPublicKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPublicKey.

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.ivs.*;
 CfnPublicKeyProps cfnPublicKeyProps = CfnPublicKeyProps.builder()
         .name("name")
         .publicKeyMaterial("publicKeyMaterial")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-publickey.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPublicKeyProps.Builder	A builder for CfnPublicKeyProps
static final class	CfnPublicKeyProps.Jsii$Proxy	An implementation for CfnPublicKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnPublicKeyProps.Builder	builder()
default String	getName()	Public key name.
default String	getPublicKeyMaterial()	The public portion of a customer-generated key pair.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

Public key name.

The value does not need to be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-publickey.html#cfn-ivs-publickey-name

getPublicKeyMaterial

@Stability(Stable)
@Nullable
default String getPublicKeyMaterial()

The public portion of a customer-generated key pair.

Note that this field is required to create the AWS::IVS::PublicKey resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-publickey.html#cfn-ivs-publickey-publickeymaterial

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-publickey.html#cfn-ivs-publickey-tags

builder

@Stability(Stable)
static CfnPublicKeyProps.Builder builder()

Returns:

a CfnPublicKeyProps.Builder of CfnPublicKeyProps