Package software.amazon.awscdk.services.connect

Class CfnSecurityKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.connect.CfnSecurityKey

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:08.691Z")
@Stability(Stable)
public class CfnSecurityKey
extends CfnResource
implements IInspectable

The security key for the instance.

Only two security keys are allowed per Amazon Connect instance.

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.connect.*;
 CfnSecurityKey cfnSecurityKey = CfnSecurityKey.Builder.create(this, "MyCfnSecurityKey")
         .instanceId("instanceId")
         .key("key")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-securitykey.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSecurityKey.Builder	A fluent builder for CfnSecurityKey.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSecurityKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityKey(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSecurityKey(software.constructs.Construct scope, String id, CfnSecurityKeyProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAssociationId()	An AssociationId is automatically generated when a storage config is associated with an instance.
protected Map<String,Object>	getCfnProperties()
String	getInstanceId()	The Amazon Resource Name (ARN) of the instance.
String	getKey()	A valid security key in PEM format.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInstanceId(String value)	The Amazon Resource Name (ARN) of the instance.
void	setKey(String value)	A valid security key in PEM format.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSecurityKey

protected CfnSecurityKey(software.amazon.jsii.JsiiObjectRef objRef)

CfnSecurityKey

protected CfnSecurityKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSecurityKey

@Stability(Stable)
public CfnSecurityKey(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSecurityKeyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociationId

@Stability(Stable)
@NotNull
public String getAttrAssociationId()

An AssociationId is automatically generated when a storage config is associated with an instance.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getInstanceId

@Stability(Stable)
@NotNull
public String getInstanceId()

The Amazon Resource Name (ARN) of the instance.

setInstanceId

@Stability(Stable)
public void setInstanceId(@NotNull
 String value)

The Amazon Resource Name (ARN) of the instance.

getKey

@Stability(Stable)
@NotNull
public String getKey()

A valid security key in PEM format.

For example:.

setKey

@Stability(Stable)
public void setKey(@NotNull
 String value)

A valid security key in PEM format.

For example:.