1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firebaserules
  5. firebaserules/v1
  6. Ruleset

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

google-native.firebaserules/v1.Ruleset

Explore with Pulumi AI

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

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset. Auto-naming is currently not supported for this resource.

Create Ruleset Resource

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

Constructor syntax

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

@overload
def Ruleset(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            source: Optional[SourceArgs] = None,
            project: Optional[str] = None)
func NewRuleset(ctx *Context, name string, args RulesetArgs, opts ...ResourceOption) (*Ruleset, error)
public Ruleset(string name, RulesetArgs args, CustomResourceOptions? opts = null)
public Ruleset(String name, RulesetArgs args)
public Ruleset(String name, RulesetArgs args, CustomResourceOptions options)
type: google-native:firebaserules/v1:Ruleset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RulesetArgs
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 rulesetResource = new GoogleNative.FirebaseRules.V1.Ruleset("rulesetResource", new()
{
    Source = new GoogleNative.FirebaseRules.V1.Inputs.SourceArgs
    {
        Files = new[]
        {
            new GoogleNative.FirebaseRules.V1.Inputs.FileArgs
            {
                Content = "string",
                Name = "string",
                Fingerprint = "string",
            },
        },
    },
    Project = "string",
});
Copy
example, err := firebaserules.NewRuleset(ctx, "rulesetResource", &firebaserules.RulesetArgs{
	Source: &firebaserules.SourceArgs{
		Files: firebaserules.FileArray{
			&firebaserules.FileArgs{
				Content:     pulumi.String("string"),
				Name:        pulumi.String("string"),
				Fingerprint: pulumi.String("string"),
			},
		},
	},
	Project: pulumi.String("string"),
})
Copy
var rulesetResource = new Ruleset("rulesetResource", RulesetArgs.builder()
    .source(SourceArgs.builder()
        .files(FileArgs.builder()
            .content("string")
            .name("string")
            .fingerprint("string")
            .build())
        .build())
    .project("string")
    .build());
Copy
ruleset_resource = google_native.firebaserules.v1.Ruleset("rulesetResource",
    source={
        "files": [{
            "content": "string",
            "name": "string",
            "fingerprint": "string",
        }],
    },
    project="string")
Copy
const rulesetResource = new google_native.firebaserules.v1.Ruleset("rulesetResource", {
    source: {
        files: [{
            content: "string",
            name: "string",
            fingerprint: "string",
        }],
    },
    project: "string",
});
Copy
type: google-native:firebaserules/v1:Ruleset
properties:
    project: string
    source:
        files:
            - content: string
              fingerprint: string
              name: string
Copy

Ruleset Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Ruleset resource accepts the following input properties:

Source This property is required. Pulumi.GoogleNative.FirebaseRules.V1.Inputs.Source
Source for the Ruleset.
Project Changes to this property will trigger replacement. string
Source This property is required. SourceArgs
Source for the Ruleset.
Project Changes to this property will trigger replacement. string
source This property is required. Source
Source for the Ruleset.
project Changes to this property will trigger replacement. String
source This property is required. Source
Source for the Ruleset.
project Changes to this property will trigger replacement. string
source This property is required. SourceArgs
Source for the Ruleset.
project Changes to this property will trigger replacement. str
source This property is required. Property Map
Source for the Ruleset.
project Changes to this property will trigger replacement. String

Outputs

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

CreateTime string
Time the Ruleset was created.
Id string
The provider-assigned unique ID for this managed resource.
Metadata Pulumi.GoogleNative.FirebaseRules.V1.Outputs.MetadataResponse
The metadata for this ruleset.
Name string
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
CreateTime string
Time the Ruleset was created.
Id string
The provider-assigned unique ID for this managed resource.
Metadata MetadataResponse
The metadata for this ruleset.
Name string
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
createTime String
Time the Ruleset was created.
id String
The provider-assigned unique ID for this managed resource.
metadata MetadataResponse
The metadata for this ruleset.
name String
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
createTime string
Time the Ruleset was created.
id string
The provider-assigned unique ID for this managed resource.
metadata MetadataResponse
The metadata for this ruleset.
name string
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
create_time str
Time the Ruleset was created.
id str
The provider-assigned unique ID for this managed resource.
metadata MetadataResponse
The metadata for this ruleset.
name str
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
createTime String
Time the Ruleset was created.
id String
The provider-assigned unique ID for this managed resource.
metadata Property Map
The metadata for this ruleset.
name String
Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}

Supporting Types

File
, FileArgs

Content This property is required. string
Textual Content.
Name This property is required. string
File name.
Fingerprint string
Fingerprint (e.g. github sha) associated with the File.
Content This property is required. string
Textual Content.
Name This property is required. string
File name.
Fingerprint string
Fingerprint (e.g. github sha) associated with the File.
content This property is required. String
Textual Content.
name This property is required. String
File name.
fingerprint String
Fingerprint (e.g. github sha) associated with the File.
content This property is required. string
Textual Content.
name This property is required. string
File name.
fingerprint string
Fingerprint (e.g. github sha) associated with the File.
content This property is required. str
Textual Content.
name This property is required. str
File name.
fingerprint str
Fingerprint (e.g. github sha) associated with the File.
content This property is required. String
Textual Content.
name This property is required. String
File name.
fingerprint String
Fingerprint (e.g. github sha) associated with the File.

FileResponse
, FileResponseArgs

Content This property is required. string
Textual Content.
Fingerprint This property is required. string
Fingerprint (e.g. github sha) associated with the File.
Name This property is required. string
File name.
Content This property is required. string
Textual Content.
Fingerprint This property is required. string
Fingerprint (e.g. github sha) associated with the File.
Name This property is required. string
File name.
content This property is required. String
Textual Content.
fingerprint This property is required. String
Fingerprint (e.g. github sha) associated with the File.
name This property is required. String
File name.
content This property is required. string
Textual Content.
fingerprint This property is required. string
Fingerprint (e.g. github sha) associated with the File.
name This property is required. string
File name.
content This property is required. str
Textual Content.
fingerprint This property is required. str
Fingerprint (e.g. github sha) associated with the File.
name This property is required. str
File name.
content This property is required. String
Textual Content.
fingerprint This property is required. String
Fingerprint (e.g. github sha) associated with the File.
name This property is required. String
File name.

MetadataResponse
, MetadataResponseArgs

Services This property is required. List<string>
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
Services This property is required. []string
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
services This property is required. List<String>
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
services This property is required. string[]
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
services This property is required. Sequence[str]
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
services This property is required. List<String>
Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.

Source
, SourceArgs

Files This property is required. List<Pulumi.GoogleNative.FirebaseRules.V1.Inputs.File>
File set constituting the Source bundle.
Files This property is required. []File
File set constituting the Source bundle.
files This property is required. List<File>
File set constituting the Source bundle.
files This property is required. File[]
File set constituting the Source bundle.
files This property is required. Sequence[File]
File set constituting the Source bundle.
files This property is required. List<Property Map>
File set constituting the Source bundle.

SourceResponse
, SourceResponseArgs

Files This property is required. List<Pulumi.GoogleNative.FirebaseRules.V1.Inputs.FileResponse>
File set constituting the Source bundle.
Files This property is required. []FileResponse
File set constituting the Source bundle.
files This property is required. List<FileResponse>
File set constituting the Source bundle.
files This property is required. FileResponse[]
File set constituting the Source bundle.
files This property is required. Sequence[FileResponse]
File set constituting the Source bundle.
files This property is required. List<Property Map>
File set constituting the Source bundle.

Package Details

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

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