Package software.amazon.awscdk.services.connect

Class CfnInstanceStorageConfig

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.CfnInstanceStorageConfig
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:55.980Z") @Stability(Stable) public class CfnInstanceStorageConfig extends CfnResource implements IInspectable
A CloudFormation AWS::Connect::InstanceStorageConfig.

The storage configuration for the 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.*;
 CfnInstanceStorageConfig cfnInstanceStorageConfig = CfnInstanceStorageConfig.Builder.create(this, "MyCfnInstanceStorageConfig")
         .instanceArn("instanceArn")
         .resourceType("resourceType")
         .storageType("storageType")
         // the properties below are optional
         .kinesisFirehoseConfig(KinesisFirehoseConfigProperty.builder()
                 .firehoseArn("firehoseArn")
                 .build())
         .kinesisStreamConfig(KinesisStreamConfigProperty.builder()
                 .streamArn("streamArn")
                 .build())
         .kinesisVideoStreamConfig(KinesisVideoStreamConfigProperty.builder()
                 .prefix("prefix")
                 .retentionPeriodHours(123)
                 // the properties below are optional
                 .encryptionConfig(EncryptionConfigProperty.builder()
                         .encryptionType("encryptionType")
                         .keyId("keyId")
                         .build())
                 .build())
         .s3Config(S3ConfigProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 // the properties below are optional
                 .encryptionConfig(EncryptionConfigProperty.builder()
                         .encryptionType("encryptionType")
                         .keyId("keyId")
                         .build())
                 .build())
         .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

    • CfnInstanceStorageConfig

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

    • CfnInstanceStorageConfig

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

    • CfnInstanceStorageConfig

      @Stability(Stable) public CfnInstanceStorageConfig(@NotNull Construct scope, @NotNull String id, @NotNull CfnInstanceStorageConfigProps props)
      Create a new AWS::Connect::InstanceStorageConfig.

      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()
      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceArn

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

    • setInstanceArn

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

    • getResourceType

      @Stability(Stable) @NotNull public String getResourceType()
      A valid resource type.

      Following are the valid resource types: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS

    • setResourceType

      @Stability(Stable) public void setResourceType(@NotNull String value)
      A valid resource type.

      Following are the valid resource types: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS

    • getStorageType

      @Stability(Stable) @NotNull public String getStorageType()
      A valid storage type.

    • setStorageType

      @Stability(Stable) public void setStorageType(@NotNull String value)
      A valid storage type.

    • getKinesisFirehoseConfig

      @Stability(Stable) @Nullable public Object getKinesisFirehoseConfig()
      The configuration of the Kinesis Firehose delivery stream.

    • setKinesisFirehoseConfig

      @Stability(Stable) public void setKinesisFirehoseConfig(@Nullable IResolvable value)
      The configuration of the Kinesis Firehose delivery stream.

    • setKinesisFirehoseConfig

      @Stability(Stable) public void setKinesisFirehoseConfig(@Nullable CfnInstanceStorageConfig.KinesisFirehoseConfigProperty value)
      The configuration of the Kinesis Firehose delivery stream.

    • getKinesisStreamConfig

      @Stability(Stable) @Nullable public Object getKinesisStreamConfig()
      The configuration of the Kinesis data stream.

    • setKinesisStreamConfig

      @Stability(Stable) public void setKinesisStreamConfig(@Nullable IResolvable value)
      The configuration of the Kinesis data stream.

    • setKinesisStreamConfig

      @Stability(Stable) public void setKinesisStreamConfig(@Nullable CfnInstanceStorageConfig.KinesisStreamConfigProperty value)
      The configuration of the Kinesis data stream.

    • getKinesisVideoStreamConfig

      @Stability(Stable) @Nullable public Object getKinesisVideoStreamConfig()
      The configuration of the Kinesis video stream.

    • setKinesisVideoStreamConfig

      @Stability(Stable) public void setKinesisVideoStreamConfig(@Nullable IResolvable value)
      The configuration of the Kinesis video stream.

    • setKinesisVideoStreamConfig

      @Stability(Stable) public void setKinesisVideoStreamConfig(@Nullable CfnInstanceStorageConfig.KinesisVideoStreamConfigProperty value)
      The configuration of the Kinesis video stream.

    • getS3Config

      @Stability(Stable) @Nullable public Object getS3Config()
      The S3 bucket configuration.

    • setS3Config

      @Stability(Stable) public void setS3Config(@Nullable IResolvable value)
      The S3 bucket configuration.

    • setS3Config

      @Stability(Stable) public void setS3Config(@Nullable CfnInstanceStorageConfig.S3ConfigProperty value)
      The S3 bucket configuration.