Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. securitycenter
  5. securitycenter/v1
  6. OrganizationMuteConfig

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.securitycenter/v1.OrganizationMuteConfig

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 mute config.

    Create OrganizationMuteConfig Resource

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

    Constructor syntax

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

@overload
def OrganizationMuteConfig(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           filter: Optional[str] = None,
                           mute_config_id: Optional[str] = None,
                           organization_id: Optional[str] = None,
                           description: Optional[str] = None,
                           display_name: Optional[str] = None,
                           name: Optional[str] = None)
    func NewOrganizationMuteConfig(ctx *Context, name string, args OrganizationMuteConfigArgs, opts ...ResourceOption) (*OrganizationMuteConfig, error)
    public OrganizationMuteConfig(string name, OrganizationMuteConfigArgs args, CustomResourceOptions? opts = null)
    public OrganizationMuteConfig(String name, OrganizationMuteConfigArgs args)
public OrganizationMuteConfig(String name, OrganizationMuteConfigArgs args, CustomResourceOptions options)

    type: google-native:securitycenter/v1:OrganizationMuteConfig
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 OrganizationMuteConfigArgs
    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 OrganizationMuteConfigArgs
    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 OrganizationMuteConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationMuteConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationMuteConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var organizationMuteConfigResource = new GoogleNative.Securitycenter.V1.OrganizationMuteConfig("organizationMuteConfigResource", new()
{
    Filter = "string",
    MuteConfigId = "string",
    OrganizationId = "string",
    Description = "string",
    DisplayName = "string",
    Name = "string",
});

    example, err := securitycenter.NewOrganizationMuteConfig(ctx, "organizationMuteConfigResource", &securitycenter.OrganizationMuteConfigArgs{
Filter: pulumi.String("string"),
MuteConfigId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var organizationMuteConfigResource = new OrganizationMuteConfig("organizationMuteConfigResource", OrganizationMuteConfigArgs.builder()        
    .filter("string")
    .muteConfigId("string")
    .organizationId("string")
    .description("string")
    .displayName("string")
    .name("string")
    .build());

    organization_mute_config_resource = google_native.securitycenter.v1.OrganizationMuteConfig("organizationMuteConfigResource",
    filter="string",
    mute_config_id="string",
    organization_id="string",
    description="string",
    display_name="string",
    name="string")

    const organizationMuteConfigResource = new google_native.securitycenter.v1.OrganizationMuteConfig("organizationMuteConfigResource", {
    filter: "string",
    muteConfigId: "string",
    organizationId: "string",
    description: "string",
    displayName: "string",
    name: "string",
});

    type: google-native:securitycenter/v1:OrganizationMuteConfig
properties:
    description: string
    displayName: string
    filter: string
    muteConfigId: string
    name: string
    organizationId: string

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

    Filter string
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    MuteConfigId string
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    OrganizationId string
    Description string
    A description of the mute config.
    DisplayName string
    The human readable name to be displayed for the mute config.
    Name string
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
    Filter string
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    MuteConfigId string
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    OrganizationId string
    Description string
    A description of the mute config.
    DisplayName string
    The human readable name to be displayed for the mute config.
    Name string
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
    filter String
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    muteConfigId String
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    organizationId String
    description String
    A description of the mute config.
    displayName String
    The human readable name to be displayed for the mute config.
    name String
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
    filter string
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    muteConfigId string
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    organizationId string
    description string
    A description of the mute config.
    displayName string
    The human readable name to be displayed for the mute config.
    name string
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
    filter str
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    mute_config_id str
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    organization_id str
    description str
    A description of the mute config.
    display_name str
    The human readable name to be displayed for the mute config.
    name str
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"
    filter String
    An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: =, : * category: =, : * resource.name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.folders.resource_folder: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.type: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
    muteConfigId String
    Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
    organizationId String
    description String
    A description of the mute config.
    displayName String
    The human readable name to be displayed for the mute config.
    name String
    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

    Outputs

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

    CreateTime string
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MostRecentEditor string
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    UpdateTime string
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
    CreateTime string
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MostRecentEditor string
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    UpdateTime string
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
    createTime String
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    id String
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor String
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    updateTime String
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
    createTime string
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    id string
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor string
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    updateTime string
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
    create_time str
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    id str
    The provider-assigned unique ID for this managed resource.
    most_recent_editor str
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    update_time str
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
    createTime String
    The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
    id String
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor String
    Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
    updateTime String
    The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.

    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