Package software.amazon.awscdk.services.connect

Class CfnSecurityKey

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.connect.CfnSecurityKey
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.015Z") @Stability(Stable) public class CfnSecurityKey extends CfnResource implements IInspectable
A CloudFormation AWS::Connect::SecurityKey.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnSecurityKeyProps props)
      Create a new AWS::Connect::SecurityKey.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

      Minimum : 1

      Maximum : 100

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@NotNull String value)
      The Amazon Resource Name (ARN) of the instance.

      Minimum : 1

      Maximum : 100

    • getKey

      @Stability(Stable) @NotNull public String getKey()
      A valid security key in PEM format.

      Minimum : 1

      Maximum : 1024

    • setKey

      @Stability(Stable) public void setKey(@NotNull String value)
      A valid security key in PEM format.

      Minimum : 1

      Maximum : 1024