@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:42.699Z") public class CfnSecurityGroupEgress extends CfnResource implements IInspectable
[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
, or DestinationSecurityGroupId
.
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
). 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 AWS::EC2::SecurityGroupIngress
and AWS::EC2::SecurityGroupEgress
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; CfnSecurityGroupEgress cfnSecurityGroupEgress = CfnSecurityGroupEgress.Builder.create(this, "MyCfnSecurityGroupEgress") .groupId("groupId") .ipProtocol("ipProtocol") // the properties below are optional .cidrIp("cidrIp") .cidrIpv6("cidrIpv6") .description("description") .destinationPrefixListId("destinationPrefixListId") .destinationSecurityGroupId("destinationSecurityGroupId") .fromPort(123) .toPort(123) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnSecurityGroupEgress.Builder
A fluent builder for
CfnSecurityGroupEgress . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnSecurityGroupEgress(Construct scope,
java.lang.String id,
CfnSecurityGroupEgressProps props)
Create a new `AWS::EC2::SecurityGroupEgress`.
|
protected |
CfnSecurityGroupEgress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnSecurityGroupEgress(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getCidrIp()
The IPv4 address range, in CIDR format.
|
java.lang.String |
getCidrIpv6()
The IPv6 address range, in CIDR format.
|
java.lang.String |
getDescription()
The description of an egress (outbound) security group rule.
|
java.lang.String |
getDestinationPrefixListId()
[EC2-VPC only] The prefix list IDs for an AWS service.
|
java.lang.String |
getDestinationSecurityGroupId()
The ID of the security group.
|
java.lang.Number |
getFromPort()
If the protocol is TCP or UDP, this is the start of the port range.
|
java.lang.String |
getGroupId()
The ID of the security group.
|
java.lang.String |
getIpProtocol()
The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
|
java.lang.Number |
getToPort()
If the protocol is TCP or UDP, this is the end of the port range.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCidrIp(java.lang.String value)
The IPv4 address range, in CIDR format.
|
void |
setCidrIpv6(java.lang.String value)
The IPv6 address range, in CIDR format.
|
void |
setDescription(java.lang.String value)
The description of an egress (outbound) security group rule.
|
void |
setDestinationPrefixListId(java.lang.String value)
[EC2-VPC only] The prefix list IDs for an AWS service.
|
void |
setDestinationSecurityGroupId(java.lang.String value)
The ID of the security group.
|
void |
setFromPort(java.lang.Number value)
If the protocol is TCP or UDP, this is the start of the port range.
|
void |
setGroupId(java.lang.String value)
The ID of the security group.
|
void |
setIpProtocol(java.lang.String value)
The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
|
void |
setToPort(java.lang.Number value)
If the protocol is TCP or UDP, this is the end of the port range.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnSecurityGroupEgress(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSecurityGroupEgress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnSecurityGroupEgress(Construct scope, java.lang.String id, CfnSecurityGroupEgressProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getGroupId()
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.
public void setGroupId(java.lang.String value)
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.
public java.lang.String getIpProtocol()
[VPC only] Use -1
to specify all protocols. When authorizing security group rules, specifying -1
or a protocol number other than tcp
, udp
, icmp
, or icmpv6
allows traffic on all ports, regardless of any port range you specify. For tcp
, udp
, and icmp
, you must specify a port range. For icmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
public void setIpProtocol(java.lang.String value)
[VPC only] Use -1
to specify all protocols. When authorizing security group rules, specifying -1
or a protocol number other than tcp
, udp
, icmp
, or icmpv6
allows traffic on all ports, regardless of any port range you specify. For tcp
, udp
, and icmp
, you must specify a port range. For icmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
public java.lang.String getCidrIp()
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
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 .
public void setCidrIp(java.lang.String value)
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
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 .
public java.lang.String getCidrIpv6()
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
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 .
public void setCidrIpv6(java.lang.String value)
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
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 .
public java.lang.String getDescription()
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
public void setDescription(java.lang.String value)
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
public java.lang.String getDestinationPrefixListId()
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
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
public void setDestinationPrefixListId(java.lang.String value)
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
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
public java.lang.String getDestinationSecurityGroupId()
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
public void setDestinationSecurityGroupId(java.lang.String value)
You must specify a destination security group ( DestinationPrefixListId
or DestinationSecurityGroupId
) or a CIDR range ( CidrIp
or CidrIpv6
).
public java.lang.Number getFromPort()
If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
public void setFromPort(java.lang.Number value)
If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
public java.lang.Number getToPort()
If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
public void setToPort(java.lang.Number value)
If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.