1. Packages
  2. Google Cloud Native
  3. API Docs
  4. gkehub
  5. gkehub/v1
  6. Scope

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.gkehub/v1.Scope

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

    Creates a Scope. Auto-naming is currently not supported for this resource.

    Create Scope Resource

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

    Constructor syntax

    new Scope(name: string, args: ScopeArgs, opts?: CustomResourceOptions);
    @overload
    def Scope(resource_name: str,
              args: ScopeArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Scope(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              scope_id: Optional[str] = None,
              labels: Optional[Mapping[str, str]] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              namespace_labels: Optional[Mapping[str, str]] = None,
              project: Optional[str] = None)
    func NewScope(ctx *Context, name string, args ScopeArgs, opts ...ResourceOption) (*Scope, error)
    public Scope(string name, ScopeArgs args, CustomResourceOptions? opts = null)
    public Scope(String name, ScopeArgs args)
    public Scope(String name, ScopeArgs args, CustomResourceOptions options)
    
    type: google-native:gkehub/v1:Scope
    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 ScopeArgs
    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 ScopeArgs
    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 ScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScopeArgs
    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 scopeResource = new GoogleNative.GKEHub.V1.Scope("scopeResource", new()
    {
        ScopeId = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Name = "string",
        NamespaceLabels = 
        {
            { "string", "string" },
        },
        Project = "string",
    });
    
    example, err := gkehub.NewScope(ctx, "scopeResource", &gkehub.ScopeArgs{
    ScopeId: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    NamespaceLabels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Project: pulumi.String("string"),
    })
    
    var scopeResource = new Scope("scopeResource", ScopeArgs.builder()
        .scopeId("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .name("string")
        .namespaceLabels(Map.of("string", "string"))
        .project("string")
        .build());
    
    scope_resource = google_native.gkehub.v1.Scope("scopeResource",
        scope_id="string",
        labels={
            "string": "string",
        },
        location="string",
        name="string",
        namespace_labels={
            "string": "string",
        },
        project="string")
    
    const scopeResource = new google_native.gkehub.v1.Scope("scopeResource", {
        scopeId: "string",
        labels: {
            string: "string",
        },
        location: "string",
        name: "string",
        namespaceLabels: {
            string: "string",
        },
        project: "string",
    });
    
    type: google-native:gkehub/v1:Scope
    properties:
        labels:
            string: string
        location: string
        name: string
        namespaceLabels:
            string: string
        project: string
        scopeId: string
    

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

    ScopeId string
    Required. Client chosen ID for the Scope. scope_id must be a ????
    Labels Dictionary<string, string>
    Optional. Labels for this Scope.
    Location string
    Name string
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    NamespaceLabels Dictionary<string, string>
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    Project string
    ScopeId string
    Required. Client chosen ID for the Scope. scope_id must be a ????
    Labels map[string]string
    Optional. Labels for this Scope.
    Location string
    Name string
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    NamespaceLabels map[string]string
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    Project string
    scopeId String
    Required. Client chosen ID for the Scope. scope_id must be a ????
    labels Map<String,String>
    Optional. Labels for this Scope.
    location String
    name String
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    namespaceLabels Map<String,String>
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    project String
    scopeId string
    Required. Client chosen ID for the Scope. scope_id must be a ????
    labels {[key: string]: string}
    Optional. Labels for this Scope.
    location string
    name string
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    namespaceLabels {[key: string]: string}
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    project string
    scope_id str
    Required. Client chosen ID for the Scope. scope_id must be a ????
    labels Mapping[str, str]
    Optional. Labels for this Scope.
    location str
    name str
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    namespace_labels Mapping[str, str]
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    project str
    scopeId String
    Required. Client chosen ID for the Scope. scope_id must be a ????
    labels Map<String>
    Optional. Labels for this Scope.
    location String
    name String
    The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
    namespaceLabels Map<String>
    Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
    project String

    Outputs

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

    CreateTime string
    When the scope was created.
    DeleteTime string
    When the scope was deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    State Pulumi.GoogleNative.GKEHub.V1.Outputs.ScopeLifecycleStateResponse
    State of the scope resource.
    Uid string
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    UpdateTime string
    When the scope was last updated.
    CreateTime string
    When the scope was created.
    DeleteTime string
    When the scope was deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    State ScopeLifecycleStateResponse
    State of the scope resource.
    Uid string
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    UpdateTime string
    When the scope was last updated.
    createTime String
    When the scope was created.
    deleteTime String
    When the scope was deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    state ScopeLifecycleStateResponse
    State of the scope resource.
    uid String
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    updateTime String
    When the scope was last updated.
    createTime string
    When the scope was created.
    deleteTime string
    When the scope was deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    state ScopeLifecycleStateResponse
    State of the scope resource.
    uid string
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    updateTime string
    When the scope was last updated.
    create_time str
    When the scope was created.
    delete_time str
    When the scope was deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    state ScopeLifecycleStateResponse
    State of the scope resource.
    uid str
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    update_time str
    When the scope was last updated.
    createTime String
    When the scope was created.
    deleteTime String
    When the scope was deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    state Property Map
    State of the scope resource.
    uid String
    Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.
    updateTime String
    When the scope was last updated.

    Supporting Types

    ScopeLifecycleStateResponse, ScopeLifecycleStateResponseArgs

    Code string
    The current state of the scope resource.
    Code string
    The current state of the scope resource.
    code String
    The current state of the scope resource.
    code string
    The current state of the scope resource.
    code str
    The current state of the scope resource.
    code String
    The current state of the scope resource.

    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