gcp.discoveryengine.AclConfig
Explore with Pulumi AI
Access Control Configuration.
To get more information about AclConfig, see:
Example Usage
Discoveryengine Aclconfig Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = new gcp.discoveryengine.AclConfig("basic", {
location: "global",
idpConfig: {
idpType: "THIRD_PARTY",
externalIdpConfig: {
workforcePoolName: "locations/global/workforcePools/cloud-console-pool-manual",
},
},
});
import pulumi
import pulumi_gcp as gcp
basic = gcp.discoveryengine.AclConfig("basic",
location="global",
idp_config={
"idp_type": "THIRD_PARTY",
"external_idp_config": {
"workforce_pool_name": "locations/global/workforcePools/cloud-console-pool-manual",
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := discoveryengine.NewAclConfig(ctx, "basic", &discoveryengine.AclConfigArgs{
Location: pulumi.String("global"),
IdpConfig: &discoveryengine.AclConfigIdpConfigArgs{
IdpType: pulumi.String("THIRD_PARTY"),
ExternalIdpConfig: &discoveryengine.AclConfigIdpConfigExternalIdpConfigArgs{
WorkforcePoolName: pulumi.String("locations/global/workforcePools/cloud-console-pool-manual"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var basic = new Gcp.DiscoveryEngine.AclConfig("basic", new()
{
Location = "global",
IdpConfig = new Gcp.DiscoveryEngine.Inputs.AclConfigIdpConfigArgs
{
IdpType = "THIRD_PARTY",
ExternalIdpConfig = new Gcp.DiscoveryEngine.Inputs.AclConfigIdpConfigExternalIdpConfigArgs
{
WorkforcePoolName = "locations/global/workforcePools/cloud-console-pool-manual",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.AclConfig;
import com.pulumi.gcp.discoveryengine.AclConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.AclConfigIdpConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.AclConfigIdpConfigExternalIdpConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var basic = new AclConfig("basic", AclConfigArgs.builder()
.location("global")
.idpConfig(AclConfigIdpConfigArgs.builder()
.idpType("THIRD_PARTY")
.externalIdpConfig(AclConfigIdpConfigExternalIdpConfigArgs.builder()
.workforcePoolName("locations/global/workforcePools/cloud-console-pool-manual")
.build())
.build())
.build());
}
}
resources:
basic:
type: gcp:discoveryengine:AclConfig
properties:
location: global
idpConfig:
idpType: THIRD_PARTY
externalIdpConfig:
workforcePoolName: locations/global/workforcePools/cloud-console-pool-manual
Create AclConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AclConfig(name: string, args: AclConfigArgs, opts?: CustomResourceOptions);
@overload
def AclConfig(resource_name: str,
args: AclConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AclConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
idp_config: Optional[AclConfigIdpConfigArgs] = None,
project: Optional[str] = None)
func NewAclConfig(ctx *Context, name string, args AclConfigArgs, opts ...ResourceOption) (*AclConfig, error)
public AclConfig(string name, AclConfigArgs args, CustomResourceOptions? opts = null)
public AclConfig(String name, AclConfigArgs args)
public AclConfig(String name, AclConfigArgs args, CustomResourceOptions options)
type: gcp:discoveryengine:AclConfig
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 AclConfigArgs
- 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 AclConfigArgs
- 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 AclConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AclConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AclConfigArgs
- 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 aclConfigResource = new Gcp.DiscoveryEngine.AclConfig("aclConfigResource", new()
{
Location = "string",
IdpConfig = new Gcp.DiscoveryEngine.Inputs.AclConfigIdpConfigArgs
{
ExternalIdpConfig = new Gcp.DiscoveryEngine.Inputs.AclConfigIdpConfigExternalIdpConfigArgs
{
WorkforcePoolName = "string",
},
IdpType = "string",
},
Project = "string",
});
example, err := discoveryengine.NewAclConfig(ctx, "aclConfigResource", &discoveryengine.AclConfigArgs{
Location: pulumi.String("string"),
IdpConfig: &discoveryengine.AclConfigIdpConfigArgs{
ExternalIdpConfig: &discoveryengine.AclConfigIdpConfigExternalIdpConfigArgs{
WorkforcePoolName: pulumi.String("string"),
},
IdpType: pulumi.String("string"),
},
Project: pulumi.String("string"),
})
var aclConfigResource = new AclConfig("aclConfigResource", AclConfigArgs.builder()
.location("string")
.idpConfig(AclConfigIdpConfigArgs.builder()
.externalIdpConfig(AclConfigIdpConfigExternalIdpConfigArgs.builder()
.workforcePoolName("string")
.build())
.idpType("string")
.build())
.project("string")
.build());
acl_config_resource = gcp.discoveryengine.AclConfig("aclConfigResource",
location="string",
idp_config={
"external_idp_config": {
"workforce_pool_name": "string",
},
"idp_type": "string",
},
project="string")
const aclConfigResource = new gcp.discoveryengine.AclConfig("aclConfigResource", {
location: "string",
idpConfig: {
externalIdpConfig: {
workforcePoolName: "string",
},
idpType: "string",
},
project: "string",
});
type: gcp:discoveryengine:AclConfig
properties:
idpConfig:
externalIdpConfig:
workforcePoolName: string
idpType: string
location: string
project: string
AclConfig 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 AclConfig resource accepts the following input properties:
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Idp
Config AclConfig Idp Config Args - Identity provider config. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- idp_
config AclConfig Idp Config Args - Identity provider config. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- idp
Config Property Map - Identity provider config. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the AclConfig resource produces the following output properties:
Look up Existing AclConfig Resource
Get an existing AclConfig 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?: AclConfigState, opts?: CustomResourceOptions): AclConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
idp_config: Optional[AclConfigIdpConfigArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None) -> AclConfig
func GetAclConfig(ctx *Context, name string, id IDInput, state *AclConfigState, opts ...ResourceOption) (*AclConfig, error)
public static AclConfig Get(string name, Input<string> id, AclConfigState? state, CustomResourceOptions? opts = null)
public static AclConfig get(String name, Output<String> id, AclConfigState state, CustomResourceOptions options)
resources: _: type: gcp:discoveryengine:AclConfig get: id: ${id}
- 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.
- Idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Idp
Config AclConfig Idp Config Args - Identity provider config. Structure is documented below.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- idp
Config AclConfig Idp Config - Identity provider config. Structure is documented below.
- location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name string
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- idp_
config AclConfig Idp Config Args - Identity provider config. Structure is documented below.
- location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name str
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- idp
Config Property Map - Identity provider config. Structure is documented below.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the aclConfig. Values are of the format
projects/{project}/locations/{location}/aclConfig
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Supporting Types
AclConfigIdpConfig, AclConfigIdpConfigArgs
- External
Idp AclConfig Config Idp Config External Idp Config - External third party identity provider config. Structure is documented below.
- Idp
Type string - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
- External
Idp AclConfig Config Idp Config External Idp Config - External third party identity provider config. Structure is documented below.
- Idp
Type string - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
- external
Idp AclConfig Config Idp Config External Idp Config - External third party identity provider config. Structure is documented below.
- idp
Type String - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
- external
Idp AclConfig Config Idp Config External Idp Config - External third party identity provider config. Structure is documented below.
- idp
Type string - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
- external_
idp_ Aclconfig Config Idp Config External Idp Config - External third party identity provider config. Structure is documented below.
- idp_
type str - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
- external
Idp Property MapConfig - External third party identity provider config. Structure is documented below.
- idp
Type String - Identity provider type.
Possible values are:
GSUITE
,THIRD_PARTY
.
AclConfigIdpConfigExternalIdpConfig, AclConfigIdpConfigExternalIdpConfigArgs
- Workforce
Pool stringName - Workforce pool name: "locations/global/workforcePools/pool_id"
- Workforce
Pool stringName - Workforce pool name: "locations/global/workforcePools/pool_id"
- workforce
Pool StringName - Workforce pool name: "locations/global/workforcePools/pool_id"
- workforce
Pool stringName - Workforce pool name: "locations/global/workforcePools/pool_id"
- workforce_
pool_ strname - Workforce pool name: "locations/global/workforcePools/pool_id"
- workforce
Pool StringName - Workforce pool name: "locations/global/workforcePools/pool_id"
Import
AclConfig can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/aclConfig
{{project}}/{{location}}
{{location}}
When using the pulumi import
command, AclConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:discoveryengine/aclConfig:AclConfig default projects/{{project}}/locations/{{location}}/aclConfig
$ pulumi import gcp:discoveryengine/aclConfig:AclConfig default {{project}}/{{location}}
$ pulumi import gcp:discoveryengine/aclConfig:AclConfig default {{location}}
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.