Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networksecurity
  5. networksecurity/v1
  6. AddressGroup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.networksecurity/v1.AddressGroup

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new address group in a given project and location.

    Create AddressGroup Resource

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

    Constructor syntax

    new AddressGroup(name: string, args: AddressGroupArgs, opts?: CustomResourceOptions);
    @overload
def AddressGroup(resource_name: str,
                 args: AddressGroupArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def AddressGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 address_group_id: Optional[str] = None,
                 capacity: Optional[int] = None,
                 type: Optional[AddressGroupType] = None,
                 description: Optional[str] = None,
                 items: Optional[Sequence[str]] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 request_id: Optional[str] = None)
    func NewAddressGroup(ctx *Context, name string, args AddressGroupArgs, opts ...ResourceOption) (*AddressGroup, error)
    public AddressGroup(string name, AddressGroupArgs args, CustomResourceOptions? opts = null)
    public AddressGroup(String name, AddressGroupArgs args)
public AddressGroup(String name, AddressGroupArgs args, CustomResourceOptions options)

    type: google-native:networksecurity/v1:AddressGroup
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 AddressGroupArgs
    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 AddressGroupArgs
    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 AddressGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressGroupArgs
    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 addressGroupResource = new GoogleNative.NetworkSecurity.V1.AddressGroup("addressGroupResource", new()
{
    AddressGroupId = "string",
    Capacity = 0,
    Type = GoogleNative.NetworkSecurity.V1.AddressGroupType.TypeUnspecified,
    Description = "string",
    Items = new[]
    {
        "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
});

    example, err := networksecurity.NewAddressGroup(ctx, "addressGroupResource", &networksecurity.AddressGroupArgs{
AddressGroupId: pulumi.String("string"),
Capacity: pulumi.Int(0),
Type: networksecurity.AddressGroupTypeTypeUnspecified,
Description: pulumi.String("string"),
Items: pulumi.StringArray{
pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
RequestId: pulumi.String("string"),
})

    var addressGroupResource = new AddressGroup("addressGroupResource", AddressGroupArgs.builder()
    .addressGroupId("string")
    .capacity(0)
    .type("TYPE_UNSPECIFIED")
    .description("string")
    .items("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .build());

    address_group_resource = google_native.networksecurity.v1.AddressGroup("addressGroupResource",
    address_group_id="string",
    capacity=0,
    type=google_native.networksecurity.v1.AddressGroupType.TYPE_UNSPECIFIED,
    description="string",
    items=["string"],
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    request_id="string")

    const addressGroupResource = new google_native.networksecurity.v1.AddressGroup("addressGroupResource", {
    addressGroupId: "string",
    capacity: 0,
    type: google_native.networksecurity.v1.AddressGroupType.TypeUnspecified,
    description: "string",
    items: ["string"],
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
});

    type: google-native:networksecurity/v1:AddressGroup
properties:
    addressGroupId: string
    capacity: 0
    description: string
    items:
        - string
    labels:
        string: string
    location: string
    name: string
    project: string
    requestId: string
    type: TYPE_UNSPECIFIED

    AddressGroup 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 AddressGroup resource accepts the following input properties:

    AddressGroupId string
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    Capacity int
    Capacity of the Address Group
    Type Pulumi.GoogleNative.NetworkSecurity.V1.AddressGroupType
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    Description string
    Optional. Free-text description of the resource.
    Items List<string>
    Optional. List of items.
    Labels Dictionary<string, string>
    Optional. Set of label tags associated with the AddressGroup resource.
    Location string
    Name string
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    AddressGroupId string
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    Capacity int
    Capacity of the Address Group
    Type AddressGroupType
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    Description string
    Optional. Free-text description of the resource.
    Items []string
    Optional. List of items.
    Labels map[string]string
    Optional. Set of label tags associated with the AddressGroup resource.
    Location string
    Name string
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    addressGroupId String
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    capacity Integer
    Capacity of the Address Group
    type AddressGroupType
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    description String
    Optional. Free-text description of the resource.
    items List<String>
    Optional. List of items.
    labels Map<String,String>
    Optional. Set of label tags associated with the AddressGroup resource.
    location String
    name String
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    addressGroupId string
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    capacity number
    Capacity of the Address Group
    type AddressGroupType
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    description string
    Optional. Free-text description of the resource.
    items string[]
    Optional. List of items.
    labels {[key: string]: string}
    Optional. Set of label tags associated with the AddressGroup resource.
    location string
    name string
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    project string
    requestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    address_group_id str
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    capacity int
    Capacity of the Address Group
    type AddressGroupType
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    description str
    Optional. Free-text description of the resource.
    items Sequence[str]
    Optional. List of items.
    labels Mapping[str, str]
    Optional. Set of label tags associated with the AddressGroup resource.
    location str
    name str
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    project str
    request_id str
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    addressGroupId String
    Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
    capacity Number
    Capacity of the Address Group
    type "TYPE_UNSPECIFIED" | "IPV4" | "IPV6"
    The type of the Address Group. Possible values are "IPv4" or "IPV6".
    description String
    Optional. Free-text description of the resource.
    items List<String>
    Optional. List of items.
    labels Map<String>
    Optional. Set of label tags associated with the AddressGroup resource.
    location String
    name String
    Name of the AddressGroup resource. It matches pattern projects/*/locations/{location}/addressGroups/.
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    Outputs

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

    CreateTime string
    The timestamp when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    UpdateTime string
    The timestamp when the resource was updated.
    CreateTime string
    The timestamp when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Server-defined fully-qualified URL for this resource.
    UpdateTime string
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    updateTime String
    The timestamp when the resource was updated.
    createTime string
    The timestamp when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Server-defined fully-qualified URL for this resource.
    updateTime string
    The timestamp when the resource was updated.
    create_time str
    The timestamp when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Server-defined fully-qualified URL for this resource.
    update_time str
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Server-defined fully-qualified URL for this resource.
    updateTime String
    The timestamp when the resource was updated.

    Supporting Types

    AddressGroupType, AddressGroupTypeArgs

    TypeUnspecified
    TYPE_UNSPECIFIEDDefault value.
    Ipv4
    IPV4IP v4 ranges.
    Ipv6
    IPV6IP v6 ranges.
    AddressGroupTypeTypeUnspecified
    TYPE_UNSPECIFIEDDefault value.
    AddressGroupTypeIpv4
    IPV4IP v4 ranges.
    AddressGroupTypeIpv6
    IPV6IP v6 ranges.
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault value.
    Ipv4
    IPV4IP v4 ranges.
    Ipv6
    IPV6IP v6 ranges.
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault value.
    Ipv4
    IPV4IP v4 ranges.
    Ipv6
    IPV6IP v6 ranges.
    TYPE_UNSPECIFIED
    TYPE_UNSPECIFIEDDefault value.
    IPV4
    IPV4IP v4 ranges.
    IPV6
    IPV6IP v6 ranges.
    "TYPE_UNSPECIFIED"
    TYPE_UNSPECIFIEDDefault value.
    "IPV4"
    IPV4IP v4 ranges.
    "IPV6"
    IPV6IP v6 ranges.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native