com.pulumi.awsnative.ec2.kotlin.SecurityGroupEgress.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.ec2.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [SecurityGroupEgress].
*/
@PulumiTagMarker
public class SecurityGroupEgressResourceBuilder internal constructor() {
public var name: String? = null
public var args: SecurityGroupEgressArgs = SecurityGroupEgressArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SecurityGroupEgressArgsBuilder.() -> Unit) {
val builder = SecurityGroupEgressArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): SecurityGroupEgress {
val builtJavaResource = com.pulumi.awsnative.ec2.SecurityGroupEgress(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return SecurityGroupEgress(builtJavaResource)
}
}
/**
* Adds the specified outbound (egress) rule to a security group.
* An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
* You must specify exactly one of the following destinations: an IPv4 address range, an 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. To specify all types or all codes, use -1.
* Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
*/
public class SecurityGroupEgress internal constructor(
override val javaResource: com.pulumi.awsnative.ec2.SecurityGroupEgress,
) : KotlinCustomResource(javaResource, SecurityGroupEgressMapper) {
public val awsId: Output
get() = javaResource.awsId().applyValue({ args0 -> args0 })
/**
* The IPv4 address range, in CIDR format.
* You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
* For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
*/
public val cidrIp: Output?
get() = javaResource.cidrIp().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The IPv6 address range, in CIDR format.
* You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
* For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
*/
public val cidrIpv6: Output?
get() = javaResource.cidrIpv6().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* 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 ._-:/()#,@[]+=;{}!$*
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.
* You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
*/
public val destinationPrefixListId: Output?
get() = javaResource.destinationPrefixListId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the security group.
* You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
*/
public val destinationSecurityGroupId: Output?
get() = javaResource.destinationSecurityGroupId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
*/
public val fromPort: Output?
get() = javaResource.fromPort().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* 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.
*/
public val groupId: Output
get() = javaResource.groupId().applyValue({ args0 -> args0 })
/**
* 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)).
* 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 val ipProtocol: Output
get() = javaResource.ipProtocol().applyValue({ args0 -> args0 })
/**
* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, 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).
*/
public val toPort: Output?
get() = javaResource.toPort().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object SecurityGroupEgressMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.ec2.SecurityGroupEgress::class == javaResource::class
override fun map(javaResource: Resource): SecurityGroupEgress = SecurityGroupEgress(
javaResource
as com.pulumi.awsnative.ec2.SecurityGroupEgress,
)
}
/**
* @see [SecurityGroupEgress].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [SecurityGroupEgress].
*/
public suspend fun securityGroupEgress(
name: String,
block: suspend SecurityGroupEgressResourceBuilder.() -> Unit,
): SecurityGroupEgress {
val builder = SecurityGroupEgressResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [SecurityGroupEgress].
* @param name The _unique_ name of the resulting resource.
*/
public fun securityGroupEgress(name: String): SecurityGroupEgress {
val builder = SecurityGroupEgressResourceBuilder()
builder.name(name)
return builder.build()
}