CfnSecurityGroup¶
-
class
aws_cdk.aws_ec2.
CfnSecurityGroup
(scope, id, *, group_description, group_name=None, security_group_egress=None, security_group_ingress=None, tags=None, vpc_id=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::SecurityGroup
.Specifies a security group. To create a security group, use the VpcId property to specify the VPC for which to create the security group.
This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates . .. epigraph:
To cross-reference two security groups in the ingress and egress rules of those security groups, use the `AWS::EC2::SecurityGroupEgress <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html>`_ and `AWS::EC2::SecurityGroupIngress <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-ingress.html>`_ resources to define your rules. Do not use the embedded ingress and egress rules in the ``AWS::EC2::SecurityGroup`` . Doing so creates a circular dependency, which AWS CloudFormation doesn't allow.
- CloudformationResource
AWS::EC2::SecurityGroup
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_security_group = ec2.CfnSecurityGroup(self, "MyCfnSecurityGroup", group_description="groupDescription", # the properties below are optional group_name="groupName", security_group_egress=[ec2.CfnSecurityGroup.EgressProperty( ip_protocol="ipProtocol", # the properties below are optional cidr_ip="cidrIp", cidr_ipv6="cidrIpv6", description="description", destination_prefix_list_id="destinationPrefixListId", destination_security_group_id="destinationSecurityGroupId", from_port=123, to_port=123 )], security_group_ingress=[ec2.CfnSecurityGroup.IngressProperty( ip_protocol="ipProtocol", # the properties below are optional cidr_ip="cidrIp", cidr_ipv6="cidrIpv6", description="description", from_port=123, source_prefix_list_id="sourcePrefixListId", source_security_group_id="sourceSecurityGroupId", source_security_group_name="sourceSecurityGroupName", source_security_group_owner_id="sourceSecurityGroupOwnerId", to_port=123 )], tags=[CfnTag( key="key", value="value" )], vpc_id="vpcId" )
Create a new
AWS::EC2::SecurityGroup
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
group_description (
str
) – A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*group_name (
Optional
[str
]) – The name of the security group. Constraints: Up to 255 characters in length. Cannot start withsg-
. Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*security_group_egress (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EgressProperty
,Dict
[str
,Any
]]],None
]) – [VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.security_group_ingress (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,IngressProperty
,Dict
[str
,Any
]]],None
]) – The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Any tags assigned to the security group.vpc_id (
Optional
[str
]) – [VPC only] The ID of the VPC for the security group.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::EC2::SecurityGroup'¶
-
attr_group_id
¶ The group ID of the specified security group, such as
sg-94b3a1f6
.- CloudformationAttribute
GroupId
- Return type
str
-
attr_vpc_id
¶ The physical ID of the VPC.
You can obtain the physical ID by using a reference to an AWS::EC2::VPC , such as:
{ "Ref" : "myVPC" }
.- CloudformationAttribute
VpcId
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
group_description
¶ A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
-
group_name
¶ The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with
sg-
.Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
security_group_egress
¶ [VPC only] The outbound rules associated with the security group.
There is a short interruption during which you cannot connect to the security group.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,EgressProperty
]],None
]
-
security_group_ingress
¶ The inbound rules associated with the security group.
There is a short interruption during which you cannot connect to the security group.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,IngressProperty
]],None
]
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Any tags assigned to the security group.
-
vpc_id
¶ [VPC only] The ID of the VPC for the security group.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
EgressProperty¶
-
class
CfnSecurityGroup.
EgressProperty
(*, ip_protocol, cidr_ip=None, cidr_ipv6=None, description=None, destination_prefix_list_id=None, destination_security_group_id=None, from_port=None, to_port=None)¶ Bases:
object
[EC2-VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
You must specify only one of the following properties:
CidrIp
,CidrIpv6
,DestinationPrefixListId
, orDestinationSecurityGroupId
.You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits .
Use
SecurityGroup.Ingress
andSecurityGroup.Egress
only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of the security group. For more information, see Amazon EC2 Security Groups .The EC2 Security Group Rule is an embedded property of the
AWS::EC2::SecurityGroup
type.- Parameters
ip_protocol (
str
) – The IP protocol name (tcp
,udp
,icmp
,icmpv6
) or number (see Protocol Numbers ). [VPC only] Use-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.cidr_ip (
Optional
[str
]) – The IPv4 address range, in CIDR format. You must specify a destination security group (DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
). For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .cidr_ipv6 (
Optional
[str
]) –The IPv6 address range, in CIDR format. You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
). For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .description (
Optional
[str
]) – A description for the security group rule. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*destination_prefix_list_id (
Optional
[str
]) – [EC2-VPC only] The prefix list IDs for the destination AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. You must specify a destination security group (DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).destination_security_group_id (
Optional
[str
]) – The ID of the destination VPC security group. You must specify a destination security group (DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).from_port (
Union
[int
,float
,None
]) – The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of-1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.to_port (
Union
[int
,float
,None
]) – The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of-1
indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 egress_property = ec2.CfnSecurityGroup.EgressProperty( ip_protocol="ipProtocol", # the properties below are optional cidr_ip="cidrIp", cidr_ipv6="cidrIpv6", description="description", destination_prefix_list_id="destinationPrefixListId", destination_security_group_id="destinationSecurityGroupId", from_port=123, to_port=123 )
Attributes
-
cidr_ip
¶ The IPv4 address range, in CIDR format.
You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .
-
cidr_ipv6
¶ The IPv6 address range, in CIDR format.
You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .
-
description
¶ A description for the security group rule.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
-
destination_prefix_list_id
¶ [EC2-VPC only] The prefix list IDs for the destination AWS service.
This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).
-
destination_security_group_id
¶ The ID of the destination VPC security group.
You must specify a destination security group (
DestinationPrefixListId
orDestinationSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).
-
from_port
¶ The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
A value of
-1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.- Link
- Return type
Union
[int
,float
,None
]
-
ip_protocol
¶ //www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml>`_ ).
[VPC only] Use
-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.- Link
- Type
The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see `Protocol Numbers <https- Type
//docs.aws.amazon.com/http
- Return type
str
-
to_port
¶ The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
A value of
-1
indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.- Link
- Return type
Union
[int
,float
,None
]
IngressProperty¶
-
class
CfnSecurityGroup.
IngressProperty
(*, ip_protocol, cidr_ip=None, cidr_ipv6=None, description=None, from_port=None, source_prefix_list_id=None, source_security_group_id=None, source_security_group_name=None, source_security_group_owner_id=None, to_port=None)¶ Bases:
object
Adds an inbound rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances associated with the specified security group.
You must specify only one of the following properties:
CidrIp
,CidrIpv6
,SourcePrefixListId
,SourceSecurityGroupId
, orSourceSecurityGroupName
.You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify a port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
You must specify a source security group (
SourcePrefixListId
,SourceSecurityGroupId
, orSourceSecurityGroupName
) or a CIDR range (CidrIp
orCidrIpv6
). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
The EC2 Security Group Rule is an embedded property of the
AWS::EC2::SecurityGroup
type.- Parameters
ip_protocol (
str
) –The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see Protocol Numbers ). [VPC only] Use-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.cidr_ip (
Optional
[str
]) –The IPv4 address range, in CIDR format. You must specify a source security group (
SourcePrefixListId
orSourceSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
). For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .cidr_ipv6 (
Optional
[str
]) –The IPv6 address range, in CIDR format. You must specify a source security group (
SourcePrefixListId
orSourceSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
). For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .description (
Optional
[str
]) – Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*from_port (
Union
[int
,float
,None
]) – The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of-1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.source_prefix_list_id (
Optional
[str
]) – [EC2-VPC only] The ID of a prefix list.source_security_group_id (
Optional
[str
]) – The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.source_security_group_name (
Optional
[str
]) – [EC2-Classic, default VPC] The name of the source security group. You can’t specify this parameter in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access. You must specify theGroupName
property or theGroupId
property. For security groups that are in a VPC, you must use theGroupId
property.source_security_group_owner_id (
Optional
[str
]) – [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can’t specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access. If you specifySourceSecurityGroupName
orSourceSecurityGroupId
and that security group is owned by a different account than the account creating the stack, you must specify theSourceSecurityGroupOwnerId
; otherwise, this property is optional.to_port (
Union
[int
,float
,None
]) – The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of-1
indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 ingress_property = ec2.CfnSecurityGroup.IngressProperty( ip_protocol="ipProtocol", # the properties below are optional cidr_ip="cidrIp", cidr_ipv6="cidrIpv6", description="description", from_port=123, source_prefix_list_id="sourcePrefixListId", source_security_group_id="sourceSecurityGroupId", source_security_group_name="sourceSecurityGroupName", source_security_group_owner_id="sourceSecurityGroupOwnerId", to_port=123 )
Attributes
-
cidr_ip
¶ The IPv4 address range, in CIDR format.
You must specify a source security group (
SourcePrefixListId
orSourceSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .
-
cidr_ipv6
¶ The IPv6 address range, in CIDR format.
You must specify a source security group (
SourcePrefixListId
orSourceSecurityGroupId
) or a CIDR range (CidrIp
orCidrIpv6
).For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide .
-
description
¶ Updates the description of an ingress (inbound) security group rule.
You can replace an existing description, or add a description to a rule that did not have one previously.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
-
from_port
¶ The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
A value of
-1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.- Link
- Return type
Union
[int
,float
,None
]
-
ip_protocol
¶ //www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml>`_ ).
[VPC only] Use
-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.- Link
- Type
The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see `Protocol Numbers <https- Type
//docs.aws.amazon.com/http
- Return type
str
-
source_prefix_list_id
¶ [EC2-VPC only] The ID of a prefix list.
-
source_security_group_id
¶ The ID of the security group.
You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
-
source_security_group_name
¶ [EC2-Classic, default VPC] The name of the source security group.
You can’t specify this parameter in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
You must specify the
GroupName
property or theGroupId
property. For security groups that are in a VPC, you must use theGroupId
property.
-
source_security_group_owner_id
¶ [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
You can’t specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify
SourceSecurityGroupName
orSourceSecurityGroupId
and that security group is owned by a different account than the account creating the stack, you must specify theSourceSecurityGroupOwnerId
; otherwise, this property is optional.
-
to_port
¶ The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
A value of
-1
indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.- Link
- Return type
Union
[int
,float
,None
]