Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigtable
  5. AuthorizedView
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.bigtable.AuthorizedView

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi
pulumi/pulumi-gcp

    Example Usage

    Create AuthorizedView Resource

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

    Constructor syntax

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

@overload
def AuthorizedView(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_name: Optional[str] = None,
                   table_name: Optional[str] = None,
                   deletion_protection: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   subset_view: Optional[AuthorizedViewSubsetViewArgs] = None)
    func NewAuthorizedView(ctx *Context, name string, args AuthorizedViewArgs, opts ...ResourceOption) (*AuthorizedView, error)
    public AuthorizedView(string name, AuthorizedViewArgs args, CustomResourceOptions? opts = null)
    public AuthorizedView(String name, AuthorizedViewArgs args)
public AuthorizedView(String name, AuthorizedViewArgs args, CustomResourceOptions options)

    type: gcp:bigtable:AuthorizedView
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 AuthorizedViewArgs
    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 AuthorizedViewArgs
    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 AuthorizedViewArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthorizedViewArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthorizedViewArgs
    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 authorizedViewResource = new Gcp.BigTable.AuthorizedView("authorizedViewResource", new()
{
    InstanceName = "string",
    TableName = "string",
    DeletionProtection = "string",
    Name = "string",
    Project = "string",
    SubsetView = new Gcp.BigTable.Inputs.AuthorizedViewSubsetViewArgs
    {
        FamilySubsets = new[]
        {
            new Gcp.BigTable.Inputs.AuthorizedViewSubsetViewFamilySubsetArgs
            {
                FamilyName = "string",
                QualifierPrefixes = new[]
                {
                    "string",
                },
                Qualifiers = new[]
                {
                    "string",
                },
            },
        },
        RowPrefixes = new[]
        {
            "string",
        },
    },
});

    example, err := bigtable.NewAuthorizedView(ctx, "authorizedViewResource", &bigtable.AuthorizedViewArgs{
	InstanceName:       pulumi.String("string"),
	TableName:          pulumi.String("string"),
	DeletionProtection: pulumi.String("string"),
	Name:               pulumi.String("string"),
	Project:            pulumi.String("string"),
	SubsetView: &bigtable.AuthorizedViewSubsetViewArgs{
		FamilySubsets: bigtable.AuthorizedViewSubsetViewFamilySubsetArray{
			&bigtable.AuthorizedViewSubsetViewFamilySubsetArgs{
				FamilyName: pulumi.String("string"),
				QualifierPrefixes: pulumi.StringArray{
					pulumi.String("string"),
				},
				Qualifiers: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		RowPrefixes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var authorizedViewResource = new AuthorizedView("authorizedViewResource", AuthorizedViewArgs.builder()
    .instanceName("string")
    .tableName("string")
    .deletionProtection("string")
    .name("string")
    .project("string")
    .subsetView(AuthorizedViewSubsetViewArgs.builder()
        .familySubsets(AuthorizedViewSubsetViewFamilySubsetArgs.builder()
            .familyName("string")
            .qualifierPrefixes("string")
            .qualifiers("string")
            .build())
        .rowPrefixes("string")
        .build())
    .build());

    authorized_view_resource = gcp.bigtable.AuthorizedView("authorizedViewResource",
    instance_name="string",
    table_name="string",
    deletion_protection="string",
    name="string",
    project="string",
    subset_view=gcp.bigtable.AuthorizedViewSubsetViewArgs(
        family_subsets=[gcp.bigtable.AuthorizedViewSubsetViewFamilySubsetArgs(
            family_name="string",
            qualifier_prefixes=["string"],
            qualifiers=["string"],
        )],
        row_prefixes=["string"],
    ))

    const authorizedViewResource = new gcp.bigtable.AuthorizedView("authorizedViewResource", {
    instanceName: "string",
    tableName: "string",
    deletionProtection: "string",
    name: "string",
    project: "string",
    subsetView: {
        familySubsets: [{
            familyName: "string",
            qualifierPrefixes: ["string"],
            qualifiers: ["string"],
        }],
        rowPrefixes: ["string"],
    },
});

    type: gcp:bigtable:AuthorizedView
properties:
    deletionProtection: string
    instanceName: string
    name: string
    project: string
    subsetView:
        familySubsets:
            - familyName: string
              qualifierPrefixes:
                - string
              qualifiers:
                - string
        rowPrefixes:
            - string
    tableName: string

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

    InstanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    TableName string
    The name of the Bigtable table in which the authorized view belongs.
    DeletionProtection string
    Name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SubsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    InstanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    TableName string
    The name of the Bigtable table in which the authorized view belongs.
    DeletionProtection string
    Name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SubsetView AuthorizedViewSubsetViewArgs
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    instanceName String
    The name of the Bigtable instance in which the authorized view belongs.
    tableName String
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection String
    name String
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    instanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    tableName string
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection string
    name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    instance_name str
    The name of the Bigtable instance in which the authorized view belongs.
    table_name str
    The name of the Bigtable table in which the authorized view belongs.
    deletion_protection str
    name str
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subset_view AuthorizedViewSubsetViewArgs
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    instanceName String
    The name of the Bigtable instance in which the authorized view belongs.
    tableName String
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection String
    name String
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView Property Map
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthorizedView Resource

    Get an existing AuthorizedView resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthorizedViewState, opts?: CustomResourceOptions): AuthorizedView
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deletion_protection: Optional[str] = None,
        instance_name: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        subset_view: Optional[AuthorizedViewSubsetViewArgs] = None,
        table_name: Optional[str] = None) -> AuthorizedView
    func GetAuthorizedView(ctx *Context, name string, id IDInput, state *AuthorizedViewState, opts ...ResourceOption) (*AuthorizedView, error)
    public static AuthorizedView Get(string name, Input<string> id, AuthorizedViewState? state, CustomResourceOptions? opts = null)
    public static AuthorizedView get(String name, Output<String> id, AuthorizedViewState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeletionProtection string
    InstanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    Name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SubsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    TableName string
    The name of the Bigtable table in which the authorized view belongs.
    DeletionProtection string
    InstanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    Name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SubsetView AuthorizedViewSubsetViewArgs
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    TableName string
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection String
    instanceName String
    The name of the Bigtable instance in which the authorized view belongs.
    name String
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    tableName String
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection string
    instanceName string
    The name of the Bigtable instance in which the authorized view belongs.
    name string
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView AuthorizedViewSubsetView
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    tableName string
    The name of the Bigtable table in which the authorized view belongs.
    deletion_protection str
    instance_name str
    The name of the Bigtable instance in which the authorized view belongs.
    name str
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subset_view AuthorizedViewSubsetViewArgs
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    table_name str
    The name of the Bigtable table in which the authorized view belongs.
    deletionProtection String
    instanceName String
    The name of the Bigtable instance in which the authorized view belongs.
    name String
    The name of the authorized view. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    subsetView Property Map
    An AuthorizedView permitting access to an explicit subset of a Table. Structure is documented below.

    tableName String
    The name of the Bigtable table in which the authorized view belongs.

    Supporting Types

    AuthorizedViewSubsetView, AuthorizedViewSubsetViewArgs

    FamilySubsets List<AuthorizedViewSubsetViewFamilySubset>
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    RowPrefixes List<string>
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").
    FamilySubsets []AuthorizedViewSubsetViewFamilySubset
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    RowPrefixes []string
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").
    familySubsets List<AuthorizedViewSubsetViewFamilySubset>
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    rowPrefixes List<String>
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").
    familySubsets AuthorizedViewSubsetViewFamilySubset[]
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    rowPrefixes string[]
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").
    family_subsets Sequence[AuthorizedViewSubsetViewFamilySubset]
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    row_prefixes Sequence[str]
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").
    familySubsets List<Property Map>
    A group of column family subsets to be included in the authorized view. This can be specified multiple times. Structure is documented below.

    rowPrefixes List<String>
    A list of Base64-encoded row prefixes to be included in the authorized view. To provide access to all rows, include the empty string as a prefix ("").

    AuthorizedViewSubsetViewFamilySubset, AuthorizedViewSubsetViewFamilySubsetArgs

    FamilyName string
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    QualifierPrefixes List<string>
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    Qualifiers List<string>
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.
    FamilyName string
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    QualifierPrefixes []string
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    Qualifiers []string
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.
    familyName String
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    qualifierPrefixes List<String>
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    qualifiers List<String>
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.
    familyName string
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    qualifierPrefixes string[]
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    qualifiers string[]
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.
    family_name str
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    qualifier_prefixes Sequence[str]
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    qualifiers Sequence[str]
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.
    familyName String
    Name of the column family to be included in the authorized view. The specified column family must exist in the parent table of this authorized view.
    qualifierPrefixes List<String>
    A list of Base64-encoded prefixes for qualifiers of the column family to be included in the authorized view. Every qualifier starting with one of these prefixes is included in the authorized view. To provide access to all qualifiers, include the empty string as a prefix ("").
    qualifiers List<String>
    A list of Base64-encoded individual exact column qualifiers of the column family to be included in the authorized view.

    Import

    Bigtable Authorized Views can be imported using any of these accepted formats:

    • projects/{{project}}/instances/{{instance_name}}/tables/{{table_name}}/authorizedViews/{{name}}

    • {{project}}/{{instance_name}}/{{table_name}}/{{name}}

    • {{instance_name}}/{{table_name}}/{{name}}

    When using the pulumi import command, Bigtable Authorized Views can be imported using one of the formats above. For example:

    $ pulumi import gcp:bigtable/authorizedView:AuthorizedView default projects/{{project}}/instances/{{instance_name}}/tables/{{table_name}}/authorizedViews/{{name}}

    $ pulumi import gcp:bigtable/authorizedView:AuthorizedView default {{project}}/{{instance_name}}/{{table_name}}/{{name}}

    $ pulumi import gcp:bigtable/authorizedView:AuthorizedView default {{instance_name}}/{{table_name}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi
    pulumi/pulumi-gcp