Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. instance
  5. getSecurityGroup
Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.instance.getSecurityGroup

Explore with Pulumi AI

scaleway logo
Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    Gets information about a Security Group.

    Using getSecurityGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecurityGroup(args: GetSecurityGroupArgs, opts?: InvokeOptions): Promise<GetSecurityGroupResult>
function getSecurityGroupOutput(args: GetSecurityGroupOutputArgs, opts?: InvokeOptions): Output<GetSecurityGroupResult>
    def get_security_group(name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       security_group_id: Optional[str] = None,
                       zone: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSecurityGroupResult
def get_security_group_output(name: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       security_group_id: Optional[pulumi.Input[str]] = None,
                       zone: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSecurityGroupResult]
    func LookupSecurityGroup(ctx *Context, args *LookupSecurityGroupArgs, opts ...InvokeOption) (*LookupSecurityGroupResult, error)
func LookupSecurityGroupOutput(ctx *Context, args *LookupSecurityGroupOutputArgs, opts ...InvokeOption) LookupSecurityGroupResultOutput

    > Note: This function is named LookupSecurityGroup in the Go SDK.

    public static class GetSecurityGroup 
{
    public static Task<GetSecurityGroupResult> InvokeAsync(GetSecurityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityGroupResult> Invoke(GetSecurityGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSecurityGroupResult> getSecurityGroup(GetSecurityGroupArgs args, InvokeOptions options)
public static Output<GetSecurityGroupResult> getSecurityGroup(GetSecurityGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: scaleway:instance/getSecurityGroup:getSecurityGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The security group name. Only one of name and security_group_id should be specified.
    ProjectId string
    The ID of the project the security group is associated with.
    SecurityGroupId string
    The security group id. Only one of name and security_group_id should be specified.
    Zone string
    zone) The zone in which the security group exists.
    Name string
    The security group name. Only one of name and security_group_id should be specified.
    ProjectId string
    The ID of the project the security group is associated with.
    SecurityGroupId string
    The security group id. Only one of name and security_group_id should be specified.
    Zone string
    zone) The zone in which the security group exists.
    name String
    The security group name. Only one of name and security_group_id should be specified.
    projectId String
    The ID of the project the security group is associated with.
    securityGroupId String
    The security group id. Only one of name and security_group_id should be specified.
    zone String
    zone) The zone in which the security group exists.
    name string
    The security group name. Only one of name and security_group_id should be specified.
    projectId string
    The ID of the project the security group is associated with.
    securityGroupId string
    The security group id. Only one of name and security_group_id should be specified.
    zone string
    zone) The zone in which the security group exists.
    name str
    The security group name. Only one of name and security_group_id should be specified.
    project_id str
    The ID of the project the security group is associated with.
    security_group_id str
    The security group id. Only one of name and security_group_id should be specified.
    zone str
    zone) The zone in which the security group exists.
    name String
    The security group name. Only one of name and security_group_id should be specified.
    projectId String
    The ID of the project the security group is associated with.
    securityGroupId String
    The security group id. Only one of name and security_group_id should be specified.
    zone String
    zone) The zone in which the security group exists.

    getSecurityGroup Result

    The following output properties are available:

    Description string
    EnableDefaultSecurity bool
    ExternalRules bool
    Id string
    The provider-assigned unique ID for this managed resource.
    InboundDefaultPolicy string
    The default policy on incoming traffic. Possible values are: accept or drop.
    InboundRules List<Pulumiverse.Scaleway.Instance.Outputs.GetSecurityGroupInboundRule>
    A list of inbound rule to add to the security group. (Structure is documented below.)
    OrganizationId string
    The ID of the organization the security group is associated with.
    OutboundDefaultPolicy string
    The default policy on outgoing traffic. Possible values are: accept or drop.
    OutboundRules List<Pulumiverse.Scaleway.Instance.Outputs.GetSecurityGroupOutboundRule>
    A list of outbound rule to add to the security group. (Structure is documented below.)
    Stateful bool
    Tags List<string>
    Name string
    ProjectId string
    SecurityGroupId string
    Zone string
    Description string
    EnableDefaultSecurity bool
    ExternalRules bool
    Id string
    The provider-assigned unique ID for this managed resource.
    InboundDefaultPolicy string
    The default policy on incoming traffic. Possible values are: accept or drop.
    InboundRules []GetSecurityGroupInboundRule
    A list of inbound rule to add to the security group. (Structure is documented below.)
    OrganizationId string
    The ID of the organization the security group is associated with.
    OutboundDefaultPolicy string
    The default policy on outgoing traffic. Possible values are: accept or drop.
    OutboundRules []GetSecurityGroupOutboundRule
    A list of outbound rule to add to the security group. (Structure is documented below.)
    Stateful bool
    Tags []string
    Name string
    ProjectId string
    SecurityGroupId string
    Zone string
    description String
    enableDefaultSecurity Boolean
    externalRules Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    inboundDefaultPolicy String
    The default policy on incoming traffic. Possible values are: accept or drop.
    inboundRules List<GetSecurityGroupInboundRule>
    A list of inbound rule to add to the security group. (Structure is documented below.)
    organizationId String
    The ID of the organization the security group is associated with.
    outboundDefaultPolicy String
    The default policy on outgoing traffic. Possible values are: accept or drop.
    outboundRules List<GetSecurityGroupOutboundRule>
    A list of outbound rule to add to the security group. (Structure is documented below.)
    stateful Boolean
    tags List<String>
    name String
    projectId String
    securityGroupId String
    zone String
    description string
    enableDefaultSecurity boolean
    externalRules boolean
    id string
    The provider-assigned unique ID for this managed resource.
    inboundDefaultPolicy string
    The default policy on incoming traffic. Possible values are: accept or drop.
    inboundRules GetSecurityGroupInboundRule[]
    A list of inbound rule to add to the security group. (Structure is documented below.)
    organizationId string
    The ID of the organization the security group is associated with.
    outboundDefaultPolicy string
    The default policy on outgoing traffic. Possible values are: accept or drop.
    outboundRules GetSecurityGroupOutboundRule[]
    A list of outbound rule to add to the security group. (Structure is documented below.)
    stateful boolean
    tags string[]
    name string
    projectId string
    securityGroupId string
    zone string
    description str
    enable_default_security bool
    external_rules bool
    id str
    The provider-assigned unique ID for this managed resource.
    inbound_default_policy str
    The default policy on incoming traffic. Possible values are: accept or drop.
    inbound_rules Sequence[GetSecurityGroupInboundRule]
    A list of inbound rule to add to the security group. (Structure is documented below.)
    organization_id str
    The ID of the organization the security group is associated with.
    outbound_default_policy str
    The default policy on outgoing traffic. Possible values are: accept or drop.
    outbound_rules Sequence[GetSecurityGroupOutboundRule]
    A list of outbound rule to add to the security group. (Structure is documented below.)
    stateful bool
    tags Sequence[str]
    name str
    project_id str
    security_group_id str
    zone str
    description String
    enableDefaultSecurity Boolean
    externalRules Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    inboundDefaultPolicy String
    The default policy on incoming traffic. Possible values are: accept or drop.
    inboundRules List<Property Map>
    A list of inbound rule to add to the security group. (Structure is documented below.)
    organizationId String
    The ID of the organization the security group is associated with.
    outboundDefaultPolicy String
    The default policy on outgoing traffic. Possible values are: accept or drop.
    outboundRules List<Property Map>
    A list of outbound rule to add to the security group. (Structure is documented below.)
    stateful Boolean
    tags List<String>
    name String
    projectId String
    securityGroupId String
    zone String

    Supporting Types

    GetSecurityGroupInboundRule

    Action string
    The action to take when rule match. Possible values are: accept or drop.
    Ip string
    The ip this rule apply to.
    IpRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    Port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    PortRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    Protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    Action string
    The action to take when rule match. Possible values are: accept or drop.
    Ip string
    The ip this rule apply to.
    IpRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    Port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    PortRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    Protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action String
    The action to take when rule match. Possible values are: accept or drop.
    ip String
    The ip this rule apply to.
    ipRange String
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port Integer
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange String
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol String
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action string
    The action to take when rule match. Possible values are: accept or drop.
    ip string
    The ip this rule apply to.
    ipRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port number
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action str
    The action to take when rule match. Possible values are: accept or drop.
    ip str
    The ip this rule apply to.
    ip_range str
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    port_range str
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol str
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action String
    The action to take when rule match. Possible values are: accept or drop.
    ip String
    The ip this rule apply to.
    ipRange String
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port Number
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange String
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol String
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.

    GetSecurityGroupOutboundRule

    Action string
    The action to take when rule match. Possible values are: accept or drop.
    Ip string
    The ip this rule apply to.
    IpRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    Port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    PortRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    Protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    Action string
    The action to take when rule match. Possible values are: accept or drop.
    Ip string
    The ip this rule apply to.
    IpRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    Port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    PortRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    Protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action String
    The action to take when rule match. Possible values are: accept or drop.
    ip String
    The ip this rule apply to.
    ipRange String
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port Integer
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange String
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol String
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action string
    The action to take when rule match. Possible values are: accept or drop.
    ip string
    The ip this rule apply to.
    ipRange string
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port number
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange string
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol string
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action str
    The action to take when rule match. Possible values are: accept or drop.
    ip str
    The ip this rule apply to.
    ip_range str
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port int
    The port this rule apply to. If no port is specified, rule will apply to all port.
    port_range str
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol str
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.
    action String
    The action to take when rule match. Possible values are: accept or drop.
    ip String
    The ip this rule apply to.
    ipRange String
    The ip range (e.g 192.168.1.0/24) this rule apply to.
    port Number
    The port this rule apply to. If no port is specified, rule will apply to all port.
    portRange String
    The port range (e.g 22-23) this rule applies to. If no port nor port_range are specified, rule will apply to all port. Only one of port and port_range should be specified.
    protocol String
    The protocol this rule apply to. Possible values are: TCP, UDP, ICMP or ANY.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway