Package: aws-solutions-constructs.aws-fargate-kinesisstreams
aws-fargate-kinesisstreams module---Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_fargate_kinesisstreamsTypescript@aws-solutions-constructs/aws-fargate-kinesisstreamsJavasoftware.amazon.awsconstructs.services.fargatekinesisstreamsOverviewThis AWS Solutions Construct deploys an AWS Fargate Service that can put records on an Amazon Kinesis Data Stream.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToKinesisStreamsProps}from'@aws-solutions-constructs/aws-fargate-kinesisstreams';import*asfargatefrom'aws-cdk-lib/aws-fargate';newFargateToKinesisStreams(this,'FargateToKinesisStreams',{publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",});Pythonfromaws_solutions_constructs.aws_fargate_kinesisstreamsimportFargateToKinesisStreamsfromaws_cdkimport(aws_fargateas_fargate,Stack)fromconstructsimportConstructFargateToKinesisStreams(self,'FargateToKinesisStreams',public_api=True,ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.fargate.*;importsoftware.amazon.awscdk.services.fargate.eventsources.*;importsoftware.amazon.awscdk.services.fargate.Runtime;importsoftware.amazon.awsconstructs.services.fargatekinesisstreams.*;newFargateToKinesisStreams(this,"FargateToKinesisStreams",newFargateToKinesisStreamsProps.Builder().publicApi(true).ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo").build());Pattern Construct PropsNameTypeDescriptionpublicApibooleanTrue if the VPC provisioned by this construct should contain Public/Private Subnets, otherwise False for the VPC to contain Isolated Subnets only. Note this property is ignored if an existing VPC is specified in theexistingVpcproperty.vpcProps?ec2.VpcPropsOptional custom properties for a new VPC the construct will create. Providing both this andexistingVpcis an error. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC.existingVpc?ec2.IVpcAn existing VPC in which to deploy the Fargate Service. Providing both this andvpcPropsis an error. If the client provides an existing Fargate Service in theexistingFargateServiceObjectproperty, this value must be the VPC where the service is running. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC.clusterProps?ecs.ClusterPropsOptional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps.ecrRepositoryArn?stringThe arn of an ECR Repository containing the image to use to generate the containers. Either this or the image property of containerDefinitionProps must be provided. format: arn:aws:ecr:region:account number:repository/Repository NameecrImageVersion?stringThe version of the image to use from the repository. Defaults to 'Latest'containerDefinitionProps?ecs.ContainerDefinitionProps | anyOptional props to define the container created for the Fargate Service. (defaults found in fargate-defaults.ts)fargateTaskDefinitionProps?ecs.FargateTaskDefinitionProps | anyOptional props to define the Fargate Task Definition for this construct. (defaults found in fargate-defaults.ts)fargateServiceProps?ecs.FargateServiceProps | anyOptional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here.existingFargateServiceObject?ecs.FargateServiceA Fargate Service already instantiated (probably by another Solutions Construct). If this is specified, then no props defining a new service can be provided, including: ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterPropsexistingContainerDefinitionObject?ecs.ContainerDefinitionA container definition already instantiated as part of a Fargate service. This must be the container in theexistingFargateServiceObject.existingStreamObj?kinesis.StreamExisting instance of a Kinesis Data Stream. Providing both this andkinesisStreamPropswill cause an error.kinesisStreamProps?kinesis.StreamPropsOptional user-provided props to override the default props for the Kinesis Data Stream. Providing both this andexistingStreamObjwill cause an error.createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch Alarms for the Kinesis Stream (defaults to true).streamEnvironmentVariableName?stringOptional Name to override the Fargate Service default environment variable name that holds the Kinesis Data Stream name value. Default: KINESIS_DATASTREAM_NAMEPattern PropertiesNameTypeDescriptionvpcec2.IVpcThe new or existing VPC used by the construct.serviceecs.FargateServiceThe new or existing AWS Fargate service used by this construct.containerecs.ContainerDefinitionThe container associated with the AWS Fargate service in the service property.kinesisStreamkinesis.StreamThe new or existing Kinesis Data Stream used by this construct.cloudwatchAlarms?cloudwatch.Alarm[]Returns the CloudWatch Alarms created to monitor the Kinesis Data Stream.Default settingsOut of the box implementation of the Construct without any overrides will set the following defaults:AWS Fargate ServiceAn AWS Fargate Service running in the isolated subnets of a new VPCMinimally-permissive IAM role for the Fargate Service to put records on the Kinesis Data StreamSets an Environment Variable named KINESIS_DATASTREAM_NAME that holds the Kinesis Data Stream Name, which is a required property of the Kinesis Data Streams SDK when making calls to itAmazon Kinesis StreamEnable server-side encryption for the Kinesis Data Stream using an AWS Managed CMKDeploy best practices CloudWatch Alarms for the Kinesis Data StreamAn Interface Endpoint on the VPC for private communication between the Fargate Service and the Kinesis Data StreamArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.