VhdZdZdZddlZ ddlZddlmZddlm Z ddl m Z ddl m Z dd l mZd Zd Zdd Zdd ZddZddZ ddZddZd dZ d!dZ d!dZd"dZ d#dZ d$dZdZedk(reyy#e$rY{wxYw)%a --- module: kinesis_stream version_added: 1.0.0 short_description: Manage a Kinesis Stream. description: - Create or Delete a Kinesis Stream. - Update the retention period of a Kinesis Stream. - Update Tags on a Kinesis Stream. - Enable/disable server side encryption on a Kinesis Stream. author: - Allen Sanabria (@linuxdynasty) options: name: description: - The name of the Kinesis Stream you are managing. required: true type: str shards: description: - The number of shards you want to have with this stream. - This is required when I(state=present) type: int retention_period: description: - The length of time (in hours) data records are accessible after they are added to the stream. - The default retention period is 24 hours and can not be less than 24 hours. - The maximum retention period is 168 hours. - The retention period can be modified during any point in time. type: int state: description: - Create or Delete the Kinesis Stream. default: present choices: [ 'present', 'absent' ] type: str wait: description: - Wait for operation to complete before returning. default: true type: bool wait_timeout: description: - How many seconds to wait for an operation to complete before timing out. default: 300 type: int tags: description: - "A dictionary of resource tags of the form: C({ tag1: value1, tag2: value2 })." aliases: [ "resource_tags" ] type: dict encryption_state: description: - Enable or Disable encryption on the Kinesis Stream. choices: [ 'enabled', 'disabled' ] type: str encryption_type: description: - The type of encryption. - Defaults to C(KMS) choices: ['KMS', 'NONE'] type: str key_id: description: - The GUID or alias for the KMS key. type: str extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules - amazon.aws.boto3 a # Note: These examples do not set authentication details, see the AWS Guide for details. # Basic creation example: - name: Set up Kinesis Stream with 10 shards and wait for the stream to become ACTIVE community.aws.kinesis_stream: name: test-stream shards: 10 wait: true wait_timeout: 600 register: test_stream # Basic creation example with tags: - name: Set up Kinesis Stream with 10 shards, tag the environment, and wait for the stream to become ACTIVE community.aws.kinesis_stream: name: test-stream shards: 10 tags: Env: development wait: true wait_timeout: 600 register: test_stream # Basic creation example with tags and increase the retention period from the default 24 hours to 48 hours: - name: Set up Kinesis Stream with 10 shards, tag the environment, increase the retention period and wait for the stream to become ACTIVE community.aws.kinesis_stream: name: test-stream retention_period: 48 shards: 10 tags: Env: development wait: true wait_timeout: 600 register: test_stream # Basic delete example: - name: Delete Kinesis Stream test-stream and wait for it to finish deleting. community.aws.kinesis_stream: name: test-stream state: absent wait: true wait_timeout: 600 register: test_stream # Basic enable encryption example: - name: Encrypt Kinesis Stream test-stream. community.aws.kinesis_stream: name: test-stream state: present shards: 1 encryption_state: enabled encryption_type: KMS key_id: alias/aws/kinesis wait: true wait_timeout: 600 register: test_stream # Basic disable encryption example: - name: Encrypt Kinesis Stream test-stream. community.aws.kinesis_stream: name: test-stream state: present shards: 1 encryption_state: disabled encryption_type: KMS key_id: alias/aws/kinesis wait: true wait_timeout: 600 register: test_stream a' stream_name: description: The name of the Kinesis Stream. returned: when state == present. type: str sample: "test-stream" stream_arn: description: The amazon resource identifier returned: when state == present. type: str sample: "arn:aws:kinesis:east-side:123456789:stream/test-stream" stream_status: description: The current state of the Kinesis Stream. returned: when state == present. type: str sample: "ACTIVE" retention_period_hours: description: Number of hours messages will be kept for a Kinesis Stream. returned: when state == present. type: int sample: 24 tags: description: Dictionary containing all the tags associated with the Kinesis stream. returned: when state == present. type: dict sample: { "Name": "Splunk", "Env": "development" } N) to_native)camel_dict_to_snake_dict)boto3_tag_list_to_ansible_dict)compare_aws_tags)AnsibleCommunityAWSModulecd}d}d|i}t} |jdi|d}d}||t |fS#tjj$r}t |}Yd}~;d}~wwxYw)a_Retrieve the tags for a Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): Name of the Kinesis stream. Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >> get_tags(client, stream_name) Returns: Tuple (bool, str, dict) F StreamNameTagsTN)dictlist_tags_for_streambotocore exceptions ClientErrorrr)client stream_nameerr_msgsuccessparamsresultses p/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/aws/plugins/modules/kinesis_stream.pyget_tagsrsGGkFfG-&--77? G;GD DD    * *A,s9A+ A&&A+cd}d}d|i}t}d}t} |rJ|jdi|d}|j|j d|d}|r |dd |d <|rJ||d<t |Dcgc] }d |d vs |c}} t || z |d <| |d<t ||d<d}|||fScc}w#t jj$r} t| }Yd} ~ 7d} ~ wwxYw)a)Retrieve a Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): Name of the Kinesis stream. Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' Returns: Tuple (bool, str, dict) r Fr TStreamDescriptionShards HasMoreShardsShardIdExclusiveStartShardIdEndingSequenceNumberSequenceNumberRangeOpenShardsCountClosedShardsCount ShardsCountNr ) r listdescribe_streamextendpoplenrrrr) rrrrrrhas_more_shardsshardssnum_closed_shardsrs r find_streamr0s-GGkFfGO VF,f,,6v67JKG MM'++h/ 0%o6O28*Y2G./  #F iq6LPQRgPh6h ij%([3D%D!"'8#$!$V  GW $$!j    * *A,s6A C,C: B=B= -C=CC4 C//C4cd}tj|z}d}t}d}|tjkDrh t||\} } }|rd}nR|dk7r| r|r|jd|k(rd}n2| sd}n-tj||tjkDrh|sd}nd |d }|||fS#tj j $r} t| }Yd} ~ jd} ~ wwxYw) aWait for the status to change for a Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client stream_name (str): The name of the kinesis stream. status (str): The status to wait for. examples. status=available, status=deleted Kwargs: wait_timeout (int): Number of seconds to wait, until this timeout is reached. check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> wait_for_status(client, stream_name, 'ACTIVE', 300) Returns: Tuple (bool, str, dict) Fr TDELETING StreamStatusNz0Wait time out reached, while waiting for resultszStatus z achieved successfully) timer r0getrrrrsleep) rrstatus wait_timeout check_modepolling_increment_secsstatus_achievedstreamr find_successfind_msgrs rwait_for_statusr@ s*99;-LO VFG  $ #-8-M *L(F"&#Fzz.1V;*.$&*O )*+  $. DF8#9: GV ++"".. #lG #s$B7B75B77C) C$$C)cBd}d}d|i} |sD|dk(r||d<|jd i|d}n:|dk(r||d<|jd i|d}nd |}n|dk(rd}n |dk(rd}nd |}||fS#tjj$r}t |}Yd }~||fSd }~wwxYw) aCreate or delete multiple tags from a Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. resource_id (str): The Amazon resource id. tags (list): List of dictionaries. examples.. [{Name: "", Values: [""]}] Kwargs: action (str): The action to perform. valid actions == create and delete default=create check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('ec2') >>> resource_id = 'pcx-123345678' >>> tags = {'env': 'development'} >>> update_tags(client, resource_id, tags) [True, ''] Returns: List (bool, str) Fr r creater TdeleteTagKeysInvalid action Nr )add_tags_to_streamremove_tags_from_streamrrrr) rrtagsactionr:rrrrs r tags_actionrJEs2GGK (F!!%v)))3F38#$(y!...88+F84!8#+F84 G     * *A, G sAA))B BBcd}d}d}t||\}}} t| |d\} } | rt||| d|\} } | s| || fS| rt||| d|\}}|rd}|||fS|||fS)a0Update tags for an amazon resource. Args: resource_id (str): The Amazon resource id. tags (dict): Dictionary of tags you want applied to the Kinesis stream. Kwargs: check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('ec2') >>> stream_name = 'test-stream' >>> tags = {'env': 'development'} >>> update_tags(client, stream_name, tags) [True, ''] Return: Tuple (bool, str) Fr T) purge_tagsrCrIr:rB)rrrJ)rrrHr:rchangedr tag_successtag_msg current_tags tags_to_settags_to_deletedelete_success delete_msgcreate_success create_msgs r update_tagsrX{s(GGG)1&+)F&K,"2 #K %0 KZ& " !7J6 6%0 KX*& "  Gw 22 GW $$c8d}d}d|i} |s?|dk(r||d<|jd i|d}n5|dk(r|jd i|d}nd|}n|dk(rd}n |dk(rd}nd|}||fS#tjj$r} t | }Yd } ~ ||fSd } ~ wwxYw) aCreate or Delete an Amazon Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): The name of the kinesis stream. Kwargs: shard_count (int): Number of shards this stream will use. action (str): The action to perform. valid actions == create and delete default=create check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> shard_count = 20 >>> stream_action(client, stream_name, shard_count, action='create') Returns: List (bool, str) Fr r rB ShardCountTrCrENr ) create_stream delete_streamrrrr) rr shard_countrItimeoutr:rrrrs r stream_actionr`s.GGK (F!'2|$$$$.v.8#$$$.v.+F84!8#+F84 G     * *A, G sAA$$B BBcVd}d}d|i} |sN|dk(r|| d<|| d<|jd i| d}n?|dk(r|| d<|| d<|jd i| d}nd |}n|dk(rd}n |dk(rd}nd |}||fS#tjj$r} t | }Yd } ~ ||fSd } ~ wwxYw) apCreate, Encrypt or Delete an Amazon Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): The name of the kinesis stream. Kwargs: shard_count (int): Number of shards this stream will use. action (str): The action to perform. valid actions == create and delete default=create encryption_type (str): NONE or KMS key_id (str): The GUID or alias for the KMS key check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> shard_count = 20 >>> stream_action(client, stream_name, shard_count, action='create', encryption_type='KMS',key_id='alias/aws') Returns: List (bool, str) Fr r start_encryptionEncryptionTypeKeyIdTstop_encryptionzInvalid encryption action Nr )start_stream_encryptionstop_stream_encryptionrrrr) rrrIencryption_typekey_idr_r:rrrrs rstream_encryption_actionrjs6GGK (F+++:'("(w...88,,+:'("(w---776vh?++,,6vh? G     * *A, G A%A33B( B##B(cVd}d}d|i} |sN|dk(r||d<|jd i|d}d|}n?|dk(r||d<|jd i|d}d |}nd |}n|dk(rd}n |dk(rd}nd |}||fS#tjj$r}t |}Yd }~||fSd }~wwxYw) aUIncrease or Decrease the retention of messages in the Kinesis stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): The name of the kinesis stream. Kwargs: retention_period (int): This is how long messages will be kept before they are discarded. This can not be less than 24 hours. action (str): The action to perform. valid actions == create and delete default=create check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> retention_period = 48 >>> retention_action(client, stream_name, retention_period, action='increase') Returns: Tuple (bool, str) Fr r increaseRetentionPeriodHoursTz+Retention Period increased successfully to decreasez+Retention Period decreased successfully to rENr ) increase_stream_retention_period decrease_stream_retention_periodrrrr) rrretention_periodrIr:rrrrs rretention_actionrss0GGK (F#1A-.777A&AGHXGYZ:%1A-.777A&AGHXGYZ+F84#:%+F84 G     * *A, G rkcd}d}|dd}|s||d< |jdi|||fS||fS#tjj$r}dt |fcYd}~Sd}~wwxYw) aIncrease or Decrease the number of shards in the Kinesis stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): The name of the kinesis stream. Kwargs: number_of_shards (int): Number of shards this stream will use. default=1 check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> number_of_shards = 3 >>> update_shard_count(client, stream_name, number_of_shards) Returns: Tuple (bool, str) Tr UNIFORM_SCALING)r ScalingTypeTargetShardCountFNr )update_shard_countrrrstr)rrnumber_of_shardsr:rrrrs rrxrxOs*GG'8I JF %5!" ! %F % % / / G 7G "".. !#a&=  !s,A  AA A c Dd} d} d} |r|rt||d||\} } }| s| d| fS|jddk(rd}||dkDrt|||d| \}}n1||dkrt|||d | \}}n||dk(r d |d |d}d} |rd} d} } | r|rt||d||\} } }| sH| d| fS| rA|s?t||\}}}|r-|ddk7r%d |d} | | | fSd|jdd} | | | fS|d|k7r]t ||||\} } | s| | | fSd} |rt||d||\} } }| s*| | | fSt||\}}}|r|ddk7r d|d} | | | fS|rt ||||\}}} | |z} |rt||d||\} } }| r | rd|d} n | r| sd|d} | | | fS)auUpdate an Amazon Kinesis Stream. Args: client (botocore.client.EC2): Boto3 client. stream_name (str): The name of the kinesis stream. Kwargs: number_of_shards (int): Number of shards this stream will use. default=1 retention_period (int): This is how long messages will be kept before they are discarded. This can not be less than 24 hours. tags (dict): The tags you want applied. wait (bool): Wait until Stream is ACTIVE. default=False wait_timeout (int): How long to wait until this operation is considered failed. default=300 check_mode (bool): This will pass DryRun as one of the parameters to the aws api. default=False Basic Usage: >>> client = boto3.client('kinesis') >>> current_stream = { 'ShardCount': 3, 'HasMoreShards': True, 'RetentionPeriodHours': 24, 'StreamName': 'test-stream', 'StreamARN': 'arn:aws:kinesis:us-west-2:123456789:stream/test-stream', 'StreamStatus': "ACTIVE' } >>> stream_name = 'test-stream' >>> retention_period = 48 >>> number_of_shards = 10 >>> update(client, current_stream, stream_name, number_of_shards, retention_period ) Returns: Tuple (bool, bool, str) TFr ACTIVEr:r4rnrmrMroz Retention z is the same as zRetention Period for z is in the process of updatingYStreamStatus has to be ACTIVE in order to modify the retention period. Current status is UNKNOWNr$zNumber of shards for Kinesis Stream z updated successfully.z did not change.)r@r6rsr0rxrX)rcurrent_streamrrzrrrHwaitr9r:rrNr wait_successwait_msgretention_changed retention_msg stream_found stream_msgrO tag_changed status_streams rupdaterqs`GGG 5D X| 6 2L(N #UH44   n - 9 % .1G"HH3CK)9*Yc40!="N3I$JJ3CK)9*Yc40!="^4J%KK",-=,>>N~^tOuNv w  #G49HK( J1+>\]00 ,7 T^h,i) ['; *9 K>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> number_of_shards = 10 >>> tags = {'env': 'test'} >>> create_stream(client, stream_name, number_of_shards, tags=tags) Returns: Tuple (bool, bool, str, dict) Fr r4r3r|r}rBrMTz!Failed to create Kinesis stream: rz# is in the process of being createdz created successfullyrmr~rrH) r r0r6r@rr`rJrsrr)rrrzrrrHrr9r:rrNrrrrrrrrVrWrOrPrQs rr\r\s^NGGGfG/:6;/O,L*n**>:jHT1@ K:jH$*        ! % !'&3 K!1(z& " G9*FG$+ +G2AK>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> delete_stream(client, stream_name) Returns: Tuple (bool, bool, str, dict) Fr rCrMTr3r}Stream z deleted successfullyz# is in the process of being deleted does not exist)r r0r`r@) rrrr9r:rrNrrrrrs rr]r]qs,GGGfG/:6;/O,L*n(XZde G,;K\j-)'$K=0EF"D'7::#K=0STK=8 GWg --rYcd}d}d} t} t||\} } } | rv| jd|k(r| jd|k(r d}d}d|d} nMt||d||| \}} |r7d}|r"t ||d || \}} } d|d } |s|d| | fSd|d } n d}d}d|d} |r>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> key_id = 'alias/aws' >>> encryption_type = 'KMS' >>> start_stream_encryption(client, stream_name,encryption_type,key_id) Returns: Tuple (bool, bool, str, dict) Fr rcrdTrz encryption already configured.rb)rIrhrir:r|r}z! encryption started successfully.z* is in the process of starting encryption.rrHr r0r6rjr@rrrrrhrirr9r:rrNrrrrrrOrPrQs rrfrfs[8GGGfG/:6;/O,L*n   . /? B~GYGYZaGbflGlGG' }4STG7) /%   GW0? X|PZ1-GWg!0 }<]^G"&gw>> / }>> client = boto3.client('kinesis') >>> stream_name = 'test-stream' >>> stop_stream_encryption(client, stream_name,encryption_type, key_id) Returns: Tuple (bool, bool, str, dict) Fr rcKMSre)rIrirhr:r|r}Trz! encryption stopped successfully.rz* is in the process of stopping encryption.NONEz encryption already stopped.z does not exist.rHrrs rrgrgsS4GGGfG/:6;/O,L*n   . /5 87( /%   GWG,;K??@s*J7K+K&&K+__main__)rF)rBF)F)rBrF)rbr r rF)rrmF)rF)rNNFrF)FrF)r r FrF)r r TrF) DOCUMENTATIONEXAMPLESRETURNr5r ImportErroransible.module_utils._textr0ansible.module_utils.common.dict_transformationsr;ansible_collections.amazon.aws.plugins.module_utils.taggingrr>ansible_collections.community.aws.plugins.module_utils.modulesrrrr0r@rJrXr`rjrsrxrr\r]rfrgr__name__r rYrrsG RE N >  1UfXxE:%%P7,t3l-%`0hlq7t4nL C%R w.t-.bbgI.ZafE.P<X~ zFu  sBB  B