authorize_security_group_ingress async ¶

async def authorize_security_group_ingress(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    cidr_ip: Optional["capo_ec2.types.string.String"] = None,
    from_port: Optional["capo_ec2.types.integer.Integer"] = None,
    group_id: Optional["capo_ec2.types.security_group_id.SecurityGroupId"] = None,
    group_name: Optional[
        "capo_ec2.types.security_group_name.SecurityGroupName"
    ] = None,
    ip_permissions: Optional[
        "capo_ec2.types.ip_permission_list.IpPermissionList"
    ] = None,
    ip_protocol: Optional["capo_ec2.types.string.String"] = None,
    source_security_group_name: Optional["capo_ec2.types.string.String"] = None,
    source_security_group_owner_id: Optional["capo_ec2.types.string.String"] = None,
    to_port: Optional["capo_ec2.types.integer.Integer"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.authorize_security_group_ingress_result.AuthorizeSecurityGroupIngressResult":
    """<p>Adds the specified inbound (ingress) rules to a security group.</p> <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html">Security group rules</a>.</p> <p>You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.</p> <p>Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.</p> <p>For examples of rules that you can add to security groups for specific access scenarios, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html">Security group rules for different use cases</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>For more information about security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        cidr_ip: <p>The IPv4 address range, in CIDR format.</p> <note> <p> Amazon Web Services <a href="https://en.wikipedia.org/wiki/Canonicalization">canonicalizes</a> IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.</p> </note> <p>To specify an IPv6 address range, use IP permissions instead.</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>
        from_port: <p>If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>
        group_id: <p>The ID of the security group.</p>
        group_name: <p>[Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.</p>
        ip_permissions: <p>The permissions for the security group rules.</p>
        ip_protocol: <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>) or number (see <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml">Protocol Numbers</a>). To specify all protocols, use <code>-1</code>.</p> <p>To specify <code>icmpv6</code>, use IP permissions instead.</p> <p>If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>
        source_security_group_name: <p>[Default VPC] The name of the source security group.</p> <p>The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.</p>
        source_security_group_owner_id: <p>The Amazon Web Services account ID for the source security group, if the source security group is in a different account.</p> <p>The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.</p>
        to_port: <p>If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>
        tag_specifications: <p>The tags applied to the security group rule.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To add a rule that allows inbound HTTP traffic from another security group
        This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.

        >>> await client.authorize_security_group_ingress(group_id='sg-111aaa22', ip_permissions=[{'IpProtocol': 'tcp', 'FromPort': 80, 'ToPort': 80, 'UserIdGroupPairs': [{'GroupId': 'sg-1a2b3c4d', 'Description': 'HTTP access from other instances'}]}])
        To add a rule that allows inbound SSH traffic from an IPv4 address range
        This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.

        >>> await client.authorize_security_group_ingress(group_id='sg-903004f8', ip_permissions=[{'IpProtocol': 'tcp', 'FromPort': 22, 'ToPort': 22, 'IpRanges': [{'CidrIp': '203.0.113.0/24', 'Description': 'SSH access from the LA office'}]}])
        To add a rule that allows inbound RDP traffic from an IPv6 address range
        This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.

        >>> await client.authorize_security_group_ingress(group_id='sg-123abc12 ', ip_permissions=[{'IpProtocol': 'tcp', 'FromPort': 3389, 'ToPort': 3389, 'Ipv6Ranges': [{'CidrIpv6': '2001:db8:1234:1a00::/64', 'Description': 'RDP access from the NY office'}]}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.authorize_security_group_ingress_request.AuthorizeSecurityGroupIngressRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.authorize_security_group_ingress_result.AuthorizeSecurityGroupIngressResult"
    ]:
        import capo_ec2._operations.amazon_ec2.authorize_security_group_ingress

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.authorize_security_group_ingress.async_authorize_security_group_ingress(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AuthorizeSecurityGroupIngress")
    )
    input_: capo_ec2.types.authorize_security_group_ingress_request.AuthorizeSecurityGroupIngressRequest = {}
    if cidr_ip is not None:
        input_["cidr_ip"] = cidr_ip
    if from_port is not None:
        input_["from_port"] = from_port
    if group_id is not None:
        input_["group_id"] = group_id
    if group_name is not None:
        input_["group_name"] = group_name
    if ip_permissions is not None:
        input_["ip_permissions"] = ip_permissions
    if ip_protocol is not None:
        input_["ip_protocol"] = ip_protocol
    if source_security_group_name is not None:
        input_["source_security_group_name"] = source_security_group_name
    if source_security_group_owner_id is not None:
        input_["source_security_group_owner_id"] = source_security_group_owner_id
    if to_port is not None:
        input_["to_port"] = to_port
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output