1. Packages
  2. Aiven Provider
  3. API Docs
  4. AlloydbomniUser
Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi

aiven.AlloydbomniUser

Explore with Pulumi AI

aiven logo
Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi

    Creates and manages an Aiven for AlloyDB Omni service user.

    This resource is in the beta stage and may change without notice. Set the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource.

    Create AlloydbomniUser Resource

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

    Constructor syntax

    new AlloydbomniUser(name: string, args: AlloydbomniUserArgs, opts?: CustomResourceOptions);
    @overload
    def AlloydbomniUser(resource_name: str,
                        args: AlloydbomniUserArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlloydbomniUser(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        username: Optional[str] = None,
                        password: Optional[str] = None,
                        pg_allow_replication: Optional[bool] = None)
    func NewAlloydbomniUser(ctx *Context, name string, args AlloydbomniUserArgs, opts ...ResourceOption) (*AlloydbomniUser, error)
    public AlloydbomniUser(string name, AlloydbomniUserArgs args, CustomResourceOptions? opts = null)
    public AlloydbomniUser(String name, AlloydbomniUserArgs args)
    public AlloydbomniUser(String name, AlloydbomniUserArgs args, CustomResourceOptions options)
    
    type: aiven:AlloydbomniUser
    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 AlloydbomniUserArgs
    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 AlloydbomniUserArgs
    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 AlloydbomniUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlloydbomniUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlloydbomniUserArgs
    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 alloydbomniUserResource = new Aiven.AlloydbomniUser("alloydbomniUserResource", new()
    {
        Project = "string",
        ServiceName = "string",
        Username = "string",
        Password = "string",
        PgAllowReplication = false,
    });
    
    example, err := aiven.NewAlloydbomniUser(ctx, "alloydbomniUserResource", &aiven.AlloydbomniUserArgs{
    	Project:            pulumi.String("string"),
    	ServiceName:        pulumi.String("string"),
    	Username:           pulumi.String("string"),
    	Password:           pulumi.String("string"),
    	PgAllowReplication: pulumi.Bool(false),
    })
    
    var alloydbomniUserResource = new AlloydbomniUser("alloydbomniUserResource", AlloydbomniUserArgs.builder()
        .project("string")
        .serviceName("string")
        .username("string")
        .password("string")
        .pgAllowReplication(false)
        .build());
    
    alloydbomni_user_resource = aiven.AlloydbomniUser("alloydbomniUserResource",
        project="string",
        service_name="string",
        username="string",
        password="string",
        pg_allow_replication=False)
    
    const alloydbomniUserResource = new aiven.AlloydbomniUser("alloydbomniUserResource", {
        project: "string",
        serviceName: "string",
        username: "string",
        password: "string",
        pgAllowReplication: false,
    });
    
    type: aiven:AlloydbomniUser
    properties:
        password: string
        pgAllowReplication: false
        project: string
        serviceName: string
        username: string
    

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

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password string
    The password of the service user.
    pgAllowReplication boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username str
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password str
    The password of the service user.
    pg_allow_replication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.

    Outputs

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

    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The service user account type, either primary or regular.
    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The service user account type, either primary or regular.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The service user account type, either primary or regular.
    accessCert string
    The access certificate for the servie user.
    accessKey string
    The access certificate key for the service user.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The service user account type, either primary or regular.
    access_cert str
    The access certificate for the servie user.
    access_key str
    The access certificate key for the service user.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The service user account type, either primary or regular.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The service user account type, either primary or regular.

    Look up Existing AlloydbomniUser Resource

    Get an existing AlloydbomniUser 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?: AlloydbomniUserState, opts?: CustomResourceOptions): AlloydbomniUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_cert: Optional[str] = None,
            access_key: Optional[str] = None,
            password: Optional[str] = None,
            pg_allow_replication: Optional[bool] = None,
            project: Optional[str] = None,
            service_name: Optional[str] = None,
            type: Optional[str] = None,
            username: Optional[str] = None) -> AlloydbomniUser
    func GetAlloydbomniUser(ctx *Context, name string, id IDInput, state *AlloydbomniUserState, opts ...ResourceOption) (*AlloydbomniUser, error)
    public static AlloydbomniUser Get(string name, Input<string> id, AlloydbomniUserState? state, CustomResourceOptions? opts = null)
    public static AlloydbomniUser get(String name, Output<String> id, AlloydbomniUserState state, CustomResourceOptions options)
    resources:  _:    type: aiven:AlloydbomniUser    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.
    The following state arguments are supported:
    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Type string
    The service user account type, either primary or regular.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    AccessCert string
    The access certificate for the servie user.
    AccessKey string
    The access certificate key for the service user.
    Password string
    The password of the service user.
    PgAllowReplication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    Type string
    The service user account type, either primary or regular.
    Username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type String
    The service user account type, either primary or regular.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert string
    The access certificate for the servie user.
    accessKey string
    The access certificate key for the service user.
    password string
    The password of the service user.
    pgAllowReplication boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type string
    The service user account type, either primary or regular.
    username string
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    access_cert str
    The access certificate for the servie user.
    access_key str
    The access certificate key for the service user.
    password str
    The password of the service user.
    pg_allow_replication bool
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type str
    The service user account type, either primary or regular.
    username str
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    accessCert String
    The access certificate for the servie user.
    accessKey String
    The access certificate key for the service user.
    password String
    The password of the service user.
    pgAllowReplication Boolean
    Allows replication. For the default avnadmin user this attribute is required and is always true.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    type String
    The service user account type, either primary or regular.
    username String
    The name of the service user for this service. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.32.0 published on Friday, Jan 17, 2025 by Pulumi