1. Packages
  2. Amazon EKS
  3. API Docs
  4. NodeGroupSecurityGroup
Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi

eks.NodeGroupSecurityGroup

Explore with Pulumi AI

eks logo
Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi

    NodeGroupSecurityGroup is a component that wraps creating a security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group.

    Create NodeGroupSecurityGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NodeGroupSecurityGroup(name: string, args: NodeGroupSecurityGroupArgs, opts?: CustomResourceOptions);
    @overload
    def NodeGroupSecurityGroup(resource_name: str,
                               args: NodeGroupSecurityGroupArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def NodeGroupSecurityGroup(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               cluster_security_group: Optional[pulumi_aws.ec2.SecurityGroup] = None,
                               eks_cluster: Optional[pulumi_aws.eks.Cluster] = None,
                               vpc_id: Optional[str] = None,
                               tags: Optional[Mapping[str, str]] = None)
    func NewNodeGroupSecurityGroup(ctx *Context, name string, args NodeGroupSecurityGroupArgs, opts ...ResourceOption) (*NodeGroupSecurityGroup, error)
    public NodeGroupSecurityGroup(string name, NodeGroupSecurityGroupArgs args, CustomResourceOptions? opts = null)
    public NodeGroupSecurityGroup(String name, NodeGroupSecurityGroupArgs args)
    public NodeGroupSecurityGroup(String name, NodeGroupSecurityGroupArgs args, CustomResourceOptions options)
    
    type: eks:NodeGroupSecurityGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args NodeGroupSecurityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NodeGroupSecurityGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NodeGroupSecurityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NodeGroupSecurityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NodeGroupSecurityGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var nodeGroupSecurityGroupResource = new Eks.NodeGroupSecurityGroup("nodeGroupSecurityGroupResource", new()
    {
        ClusterSecurityGroup = securityGroup,
        EksCluster = cluster,
        VpcId = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := eks.NewNodeGroupSecurityGroup(ctx, "nodeGroupSecurityGroupResource", &eks.NodeGroupSecurityGroupArgs{
    ClusterSecurityGroup: pulumi.Any(securityGroup),
    EksCluster: pulumi.Any(cluster),
    VpcId: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var nodeGroupSecurityGroupResource = new NodeGroupSecurityGroup("nodeGroupSecurityGroupResource", NodeGroupSecurityGroupArgs.builder()
        .clusterSecurityGroup(securityGroup)
        .eksCluster(cluster)
        .vpcId("string")
        .tags(Map.of("string", "string"))
        .build());
    
    node_group_security_group_resource = eks.NodeGroupSecurityGroup("nodeGroupSecurityGroupResource",
        cluster_security_group=security_group,
        eks_cluster=cluster,
        vpc_id="string",
        tags={
            "string": "string",
        })
    
    const nodeGroupSecurityGroupResource = new eks.NodeGroupSecurityGroup("nodeGroupSecurityGroupResource", {
        clusterSecurityGroup: securityGroup,
        eksCluster: cluster,
        vpcId: "string",
        tags: {
            string: "string",
        },
    });
    
    type: eks:NodeGroupSecurityGroup
    properties:
        clusterSecurityGroup: ${securityGroup}
        eksCluster: ${cluster}
        tags:
            string: string
        vpcId: string
    

    NodeGroupSecurityGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NodeGroupSecurityGroup resource accepts the following input properties:

    ClusterSecurityGroup Pulumi.Aws.Ec2.SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    EksCluster Pulumi.Aws.Eks.Cluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    VpcId string
    The VPC in which to create the worker node group.
    Tags Dictionary<string, string>
    Key-value mapping of tags to apply to this security group.
    ClusterSecurityGroup SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    EksCluster Cluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    VpcId string
    The VPC in which to create the worker node group.
    Tags map[string]string
    Key-value mapping of tags to apply to this security group.
    clusterSecurityGroup SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    eksCluster Cluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    vpcId String
    The VPC in which to create the worker node group.
    tags Map<String,String>
    Key-value mapping of tags to apply to this security group.
    clusterSecurityGroup pulumiAwsec2SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    eksCluster pulumiAwseksCluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    vpcId string
    The VPC in which to create the worker node group.
    tags {[key: string]: string}
    Key-value mapping of tags to apply to this security group.
    cluster_security_group pulumi_aws.ec2.SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    eks_cluster pulumi_aws.eks.Cluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    vpc_id str
    The VPC in which to create the worker node group.
    tags Mapping[str, str]
    Key-value mapping of tags to apply to this security group.
    clusterSecurityGroup aws:ec2:SecurityGroup
    The security group associated with the EKS cluster. This type is defined in the AWS Classic package.
    eksCluster aws:eks:Cluster
    The EKS cluster associated with the worker node group This type is defined in the AWS Classic package.
    vpcId String
    The VPC in which to create the worker node group.
    tags Map<String>
    Key-value mapping of tags to apply to this security group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NodeGroupSecurityGroup resource produces the following output properties:

    SecurityGroup Pulumi.Aws.Ec2.SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    SecurityGroupRule Pulumi.Aws.Ec2.SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.
    SecurityGroup SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    SecurityGroupRule SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.
    securityGroup SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    securityGroupRule SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.
    securityGroup pulumiAwsec2SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    securityGroupRule pulumiAwsec2SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.
    security_group pulumi_aws.ec2.SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    security_group_rule pulumi_aws.ec2.SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.
    securityGroup aws:ec2:SecurityGroup
    The security group for node groups with the default ingress & egress rules required to connect and work with the EKS cluster security group. This type is defined in the AWS Classic package.
    securityGroupRule aws:ec2:SecurityGroupRule
    The EKS cluster ingress rule. This type is defined in the AWS Classic package.

    Package Details

    Repository
    Amazon EKS pulumi/pulumi-eks
    License
    Apache-2.0
    eks logo
    Amazon EKS v2.7.1 published on Thursday, Jun 13, 2024 by Pulumi