software.amazon.awscdk.services.ec2

Interface CfnSecurityGroupEgressProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityGroupEgressProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.295Z")
 @Stability(value=Stable)
public interface CfnSecurityGroupEgressProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnSecurityGroupEgress`.

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.*;
 CfnSecurityGroupEgressProps cfnSecurityGroupEgressProps = CfnSecurityGroupEgressProps.builder()
         .groupId("groupId")
         .ipProtocol("ipProtocol")
         // the properties below are optional
         .cidrIp("cidrIp")
         .cidrIpv6("cidrIpv6")
         .description("description")
         .destinationPrefixListId("destinationPrefixListId")
         .destinationSecurityGroupId("destinationSecurityGroupId")
         .fromPort(123)
         .toPort(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSecurityGroupEgressProps.Builder A builder for CfnSecurityGroupEgressProps
static class	CfnSecurityGroupEgressProps.Jsii$Proxy An implementation for CfnSecurityGroupEgressProps

Method Summary

Modifier and Type	Method and Description
static CfnSecurityGroupEgressProps.Builder	builder()
default String	getCidrIp() The IPv4 address range, in CIDR format.
default String	getCidrIpv6() The IPv6 address range, in CIDR format.
default String	getDescription() The description of an egress (outbound) security group rule.
default String	getDestinationPrefixListId() [EC2-VPC only] The prefix list IDs for an AWS service.
default String	getDestinationSecurityGroupId() The ID of the security group.
default Number	getFromPort() The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
String	getGroupId() The ID of the security group.
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) ).
default Number	getToPort() The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGroupId

@Stability(value=Stable)
 @NotNull
String getGroupId()

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.

getIpProtocol

@Stability(value=Stable)
 @NotNull
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) ).

[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.

getCidrIp

@Stability(value=Stable)
 @Nullable
default String getCidrIp()

The IPv4 address range, in CIDR format.

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 .

getCidrIpv6

@Stability(value=Stable)
 @Nullable
default String getCidrIpv6()

The IPv6 address range, in CIDR format.

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 .

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The description of an egress (outbound) security group rule.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

getDestinationPrefixListId

@Stability(value=Stable)
 @Nullable
default String getDestinationPrefixListId()

[EC2-VPC only] The prefix list IDs for an 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 or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

getDestinationSecurityGroupId

@Stability(value=Stable)
 @Nullable
default String getDestinationSecurityGroupId()

The ID of the security group.

You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

getFromPort

@Stability(value=Stable)
 @Nullable
default Number getFromPort()

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.

getToPort

@Stability(value=Stable)
 @Nullable
default Number getToPort()

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.

builder

@Stability(value=Stable)
static CfnSecurityGroupEgressProps.Builder builder()

Returns:

a CfnSecurityGroupEgressProps.Builder of CfnSecurityGroupEgressProps