Docs Packages
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. S3Credential
OVHCloud v0.42.0 published on Tuesday, Apr 9, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.S3Credential

Explore with Pulumi AI

ovh logo
OVHCloud v0.42.0 published on Tuesday, Apr 9, 2024 by OVHcloud
ovh/pulumi-ovh

    Creates an S3 Credential for a user in a public cloud project.

    Create S3Credential Resource

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

    Constructor syntax

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

@overload
def S3Credential(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 service_name: Optional[str] = None,
                 user_id: Optional[str] = None)
    func NewS3Credential(ctx *Context, name string, args S3CredentialArgs, opts ...ResourceOption) (*S3Credential, error)
    public S3Credential(string name, S3CredentialArgs args, CustomResourceOptions? opts = null)
    public S3Credential(String name, S3CredentialArgs args)
public S3Credential(String name, S3CredentialArgs args, CustomResourceOptions options)

    type: ovh:CloudProject:S3Credential
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 S3CredentialArgs
    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 S3CredentialArgs
    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 S3CredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args S3CredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args S3CredentialArgs
    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 s3credentialResource = new Ovh.CloudProject.S3Credential("s3credentialResource", new()
{
    ServiceName = "string",
    UserId = "string",
});

    example, err := CloudProject.NewS3Credential(ctx, "s3credentialResource", &CloudProject.S3CredentialArgs{
	ServiceName: pulumi.String("string"),
	UserId:      pulumi.String("string"),
})

    var s3credentialResource = new S3Credential("s3credentialResource", S3CredentialArgs.builder()        
    .serviceName("string")
    .userId("string")
    .build());

    s3credential_resource = ovh.cloud_project.S3Credential("s3credentialResource",
    service_name="string",
    user_id="string")

    const s3credentialResource = new ovh.cloudproject.S3Credential("s3credentialResource", {
    serviceName: "string",
    userId: "string",
});

    type: ovh:CloudProject:S3Credential
properties:
    serviceName: string
    userId: string

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

    ServiceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    UserId string
    The ID of a public cloud project's user.
    ServiceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    UserId string
    The ID of a public cloud project's user.
    serviceName String
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId String
    The ID of a public cloud project's user.
    serviceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId string
    The ID of a public cloud project's user.
    service_name str
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    user_id str
    The ID of a public cloud project's user.
    serviceName String
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId String
    The ID of a public cloud project's user.

    Outputs

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

    AccessKeyId string
    the Access Key ID
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalUserId string
    SecretAccessKey string
    (Sensitive) the Secret Access Key
    AccessKeyId string
    the Access Key ID
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalUserId string
    SecretAccessKey string
    (Sensitive) the Secret Access Key
    accessKeyId String
    the Access Key ID
    id String
    The provider-assigned unique ID for this managed resource.
    internalUserId String
    secretAccessKey String
    (Sensitive) the Secret Access Key
    accessKeyId string
    the Access Key ID
    id string
    The provider-assigned unique ID for this managed resource.
    internalUserId string
    secretAccessKey string
    (Sensitive) the Secret Access Key
    access_key_id str
    the Access Key ID
    id str
    The provider-assigned unique ID for this managed resource.
    internal_user_id str
    secret_access_key str
    (Sensitive) the Secret Access Key
    accessKeyId String
    the Access Key ID
    id String
    The provider-assigned unique ID for this managed resource.
    internalUserId String
    secretAccessKey String
    (Sensitive) the Secret Access Key

    Look up Existing S3Credential Resource

    Get an existing S3Credential 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?: S3CredentialState, opts?: CustomResourceOptions): S3Credential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key_id: Optional[str] = None,
        internal_user_id: Optional[str] = None,
        secret_access_key: Optional[str] = None,
        service_name: Optional[str] = None,
        user_id: Optional[str] = None) -> S3Credential
    func GetS3Credential(ctx *Context, name string, id IDInput, state *S3CredentialState, opts ...ResourceOption) (*S3Credential, error)
    public static S3Credential Get(string name, Input<string> id, S3CredentialState? state, CustomResourceOptions? opts = null)
    public static S3Credential get(String name, Output<String> id, S3CredentialState 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:
    AccessKeyId string
    the Access Key ID
    InternalUserId string
    SecretAccessKey string
    (Sensitive) the Secret Access Key
    ServiceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    UserId string
    The ID of a public cloud project's user.
    AccessKeyId string
    the Access Key ID
    InternalUserId string
    SecretAccessKey string
    (Sensitive) the Secret Access Key
    ServiceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    UserId string
    The ID of a public cloud project's user.
    accessKeyId String
    the Access Key ID
    internalUserId String
    secretAccessKey String
    (Sensitive) the Secret Access Key
    serviceName String
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId String
    The ID of a public cloud project's user.
    accessKeyId string
    the Access Key ID
    internalUserId string
    secretAccessKey string
    (Sensitive) the Secret Access Key
    serviceName string
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId string
    The ID of a public cloud project's user.
    access_key_id str
    the Access Key ID
    internal_user_id str
    secret_access_key str
    (Sensitive) the Secret Access Key
    service_name str
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    user_id str
    The ID of a public cloud project's user.
    accessKeyId String
    the Access Key ID
    internalUserId String
    secretAccessKey String
    (Sensitive) the Secret Access Key
    serviceName String
    The ID of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    userId String
    The ID of a public cloud project's user.

    Import

    OVHcloud User S3 Credentials can be imported using the service_name, user_id and access_key_id of the credential, separated by “/” E.g.,

    bash

    $ pulumi import ovh:CloudProject/s3Credential:S3Credential s3_credential service_name/user_id/access_key_id

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

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v0.42.0 published on Tuesday, Apr 9, 2024 by OVHcloud
    ovh/pulumi-ovh