Package: aws-solutions-constructs.aws-fargate-kinesisfirehose
aws-fargate-kinesisfirehose module---Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_fargate_kinesisfirehoseTypescript@aws-solutions-constructs/aws-fargate-kinesisfirehoseJavasoftware.amazon.awsconstructs.services.fargatekinesisfirehoseOverviewThis AWS Solutions Construct deploys an AWS Fargate Service that can put records on an Amazon Firehose Delivery Stream.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{FargateToKinesisFirehoseProps}from'@aws-solutions-constructs/aws-fargate-kinesisfirehose';import*asfargatefrom'aws-cdk-lib/aws-fargate';//TheconstructrequiresanexistingFirehoseDeliveryStream,thiscanbecreatedinrawCDKorextracted//fromapreviouslyinstantiatedconstructthatcreatedanFirehoseDeliveryStreamconstexistingFirehoseDeliveryStream=previouslyCreatedKinesisFirehoseToS3Construct.kinesisFirehose;newFargateToKinesisFirehose(this,'FargateToKinesisFirehose',{publicApi:true,ecrRepositoryArn:"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",existingKinesisFirehose:existingFirehoseDeliveryStream});Pythonfromaws_solutions_constructs.aws_fargate_kinesisfirehoseimportFargateToKinesisFirehosefromaws_cdkimport(aws_fargateas_fargate,Stack)fromconstructsimportConstruct# The construct requires an existing Firehose Delivery Stream, this can be created in raw CDK or extracted# from a previously instantiated construct that created an Firehose Delivery StreamexistingFirehoseDeliveryStream=previouslyCreatedKinesisFirehoseToS3Construct.kinesisFirehose;FargateToKinesisFirehose(self,'FargateToKinesisFirehose',public_api=True,ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",existingKinesisFirehose=existingFirehoseDeliveryStream)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.fargatekinesisfirehose.*;// The construct requires an existing Firehose Delivery Stream, this can be created in raw CDK or extracted// from a previously instantiated construct that created an Firehose Delivery StreamexistingFirehoseDeliveryStream=previouslyCreatedKinesisFirehoseToS3Construct.kinesisFirehose;newFargateToKinesisFirehose(this,"FargateToKinesisFirehose",newFargateToKinesisFirehoseProps.Builder().publicApi(true).ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo").existingKinesisFirehose(existingFirehoseDeliveryStream).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 the existingVpc property. If you are getting a container from a public repo, this must be true so the repo can be accessed from the network.vpcProps?ec2.VpcPropsOptional custom properties for a new VPC the construct will create. Providing both this andexistingVpcis an error. An Amazon Kinesis Firehose 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 Firehose 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.existingKinesisFirehosekinesisfirehose.CfnDeliveryStreamAn existing Kinesis Firehose Delivery Stream to which the Fargate container can put data. Note - the delivery stream construct must have already been created and have the deliveryStreamName set. This construct willnotcreate a new Delivery Stream.firehoseEnvironmentVariableName?stringOptional Name for the Fargate container environment variable set to the name of the delivery stream. Default: FIREHOSE_DELIVERYSTREAM_NAMEPattern PropertiesNameTypeDescriptionvpcec2.IVpcThe new or existing VPC used by the construct.fargateServiceecs.FargateServiceThe new or existing AWS Fargate service used by this construct.containerecs.ContainerDefinitionThe container associated with the AWS Fargate service in the service property.kinesisFirehosekinesisfirehose.CfnDeliveryStreamThe Kinesis Firehose Delivery Stream used by the construct.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 Firehose Delivery StreamSets an Environment Variable named FIREHOSE_DELIVERYSTREAM_NAME that holds the Firehose Delivery Stream Name, which is a required property of the Kinesis Firehose SDK when making calls to itAmazon Firehose Delivery StreamThis construct must be provided a configured Firehose Data Stream construct, it does not change this Stream.Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.