1. Packages
  2. Spotinst Provider
  3. API Docs
  4. CredentialsGcp
Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi

spotinst.CredentialsGcp

Explore with Pulumi AI

spotinst logo
Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Provides a Spotinst credential GCP resource.

    Create CredentialsGcp Resource

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

    Constructor syntax

    new CredentialsGcp(name: string, args: CredentialsGcpArgs, opts?: CustomResourceOptions);
    @overload
    def CredentialsGcp(resource_name: str,
                       args: CredentialsGcpArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def CredentialsGcp(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_id: Optional[str] = None,
                       auth_provider_x509_cert_url: Optional[str] = None,
                       auth_uri: Optional[str] = None,
                       client_email: Optional[str] = None,
                       client_id: Optional[str] = None,
                       client_x509_cert_url: Optional[str] = None,
                       private_key: Optional[str] = None,
                       private_key_id: Optional[str] = None,
                       project_id: Optional[str] = None,
                       token_uri: Optional[str] = None,
                       type: Optional[str] = None)
    func NewCredentialsGcp(ctx *Context, name string, args CredentialsGcpArgs, opts ...ResourceOption) (*CredentialsGcp, error)
    public CredentialsGcp(string name, CredentialsGcpArgs args, CustomResourceOptions? opts = null)
    public CredentialsGcp(String name, CredentialsGcpArgs args)
    public CredentialsGcp(String name, CredentialsGcpArgs args, CustomResourceOptions options)
    
    type: spotinst:CredentialsGcp
    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 CredentialsGcpArgs
    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 CredentialsGcpArgs
    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 CredentialsGcpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CredentialsGcpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CredentialsGcpArgs
    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 credentialsGcpResource = new SpotInst.CredentialsGcp("credentialsGcpResource", new()
    {
        AccountId = "string",
        AuthProviderX509CertUrl = "string",
        AuthUri = "string",
        ClientEmail = "string",
        ClientId = "string",
        ClientX509CertUrl = "string",
        PrivateKey = "string",
        PrivateKeyId = "string",
        ProjectId = "string",
        TokenUri = "string",
        Type = "string",
    });
    
    example, err := spotinst.NewCredentialsGcp(ctx, "credentialsGcpResource", &spotinst.CredentialsGcpArgs{
    	AccountId:               pulumi.String("string"),
    	AuthProviderX509CertUrl: pulumi.String("string"),
    	AuthUri:                 pulumi.String("string"),
    	ClientEmail:             pulumi.String("string"),
    	ClientId:                pulumi.String("string"),
    	ClientX509CertUrl:       pulumi.String("string"),
    	PrivateKey:              pulumi.String("string"),
    	PrivateKeyId:            pulumi.String("string"),
    	ProjectId:               pulumi.String("string"),
    	TokenUri:                pulumi.String("string"),
    	Type:                    pulumi.String("string"),
    })
    
    var credentialsGcpResource = new CredentialsGcp("credentialsGcpResource", CredentialsGcpArgs.builder()
        .accountId("string")
        .authProviderX509CertUrl("string")
        .authUri("string")
        .clientEmail("string")
        .clientId("string")
        .clientX509CertUrl("string")
        .privateKey("string")
        .privateKeyId("string")
        .projectId("string")
        .tokenUri("string")
        .type("string")
        .build());
    
    credentials_gcp_resource = spotinst.CredentialsGcp("credentialsGcpResource",
        account_id="string",
        auth_provider_x509_cert_url="string",
        auth_uri="string",
        client_email="string",
        client_id="string",
        client_x509_cert_url="string",
        private_key="string",
        private_key_id="string",
        project_id="string",
        token_uri="string",
        type="string")
    
    const credentialsGcpResource = new spotinst.CredentialsGcp("credentialsGcpResource", {
        accountId: "string",
        authProviderX509CertUrl: "string",
        authUri: "string",
        clientEmail: "string",
        clientId: "string",
        clientX509CertUrl: "string",
        privateKey: "string",
        privateKeyId: "string",
        projectId: "string",
        tokenUri: "string",
        type: "string",
    });
    
    type: spotinst:CredentialsGcp
    properties:
        accountId: string
        authProviderX509CertUrl: string
        authUri: string
        clientEmail: string
        clientId: string
        clientX509CertUrl: string
        privateKey: string
        privateKeyId: string
        projectId: string
        tokenUri: string
        type: string
    

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

    AccountId string
    The ID of the account associated with your token.
    AuthProviderX509CertUrl string
    .
    AuthUri string
    Authentication uri.
    ClientEmail string
    Email associated with service account.
    ClientId string
    Client ID of service account.
    ClientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    PrivateKey string
    Private key of JSON key created during prerequisites stage.
    PrivateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    ProjectId string
    Name of project in GCP.
    TokenUri string
    Token uri.
    Type string
    Valid values - service_account.
    AccountId string
    The ID of the account associated with your token.
    AuthProviderX509CertUrl string
    .
    AuthUri string
    Authentication uri.
    ClientEmail string
    Email associated with service account.
    ClientId string
    Client ID of service account.
    ClientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    PrivateKey string
    Private key of JSON key created during prerequisites stage.
    PrivateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    ProjectId string
    Name of project in GCP.
    TokenUri string
    Token uri.
    Type string
    Valid values - service_account.
    accountId String
    The ID of the account associated with your token.
    authProviderX509CertUrl String
    .
    authUri String
    Authentication uri.
    clientEmail String
    Email associated with service account.
    clientId String
    Client ID of service account.
    clientX509CertUrl String
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey String
    Private key of JSON key created during prerequisites stage.
    privateKeyId String
    Private key ID of JSON key created during prerequisites stage.
    projectId String
    Name of project in GCP.
    tokenUri String
    Token uri.
    type String
    Valid values - service_account.
    accountId string
    The ID of the account associated with your token.
    authProviderX509CertUrl string
    .
    authUri string
    Authentication uri.
    clientEmail string
    Email associated with service account.
    clientId string
    Client ID of service account.
    clientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey string
    Private key of JSON key created during prerequisites stage.
    privateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    projectId string
    Name of project in GCP.
    tokenUri string
    Token uri.
    type string
    Valid values - service_account.
    account_id str
    The ID of the account associated with your token.
    auth_provider_x509_cert_url str
    .
    auth_uri str
    Authentication uri.
    client_email str
    Email associated with service account.
    client_id str
    Client ID of service account.
    client_x509_cert_url str
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    private_key str
    Private key of JSON key created during prerequisites stage.
    private_key_id str
    Private key ID of JSON key created during prerequisites stage.
    project_id str
    Name of project in GCP.
    token_uri str
    Token uri.
    type str
    Valid values - service_account.
    accountId String
    The ID of the account associated with your token.
    authProviderX509CertUrl String
    .
    authUri String
    Authentication uri.
    clientEmail String
    Email associated with service account.
    clientId String
    Client ID of service account.
    clientX509CertUrl String
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey String
    Private key of JSON key created during prerequisites stage.
    privateKeyId String
    Private key ID of JSON key created during prerequisites stage.
    projectId String
    Name of project in GCP.
    tokenUri String
    Token uri.
    type String
    Valid values - service_account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CredentialsGcp 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 CredentialsGcp Resource

    Get an existing CredentialsGcp 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?: CredentialsGcpState, opts?: CustomResourceOptions): CredentialsGcp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            auth_provider_x509_cert_url: Optional[str] = None,
            auth_uri: Optional[str] = None,
            client_email: Optional[str] = None,
            client_id: Optional[str] = None,
            client_x509_cert_url: Optional[str] = None,
            private_key: Optional[str] = None,
            private_key_id: Optional[str] = None,
            project_id: Optional[str] = None,
            token_uri: Optional[str] = None,
            type: Optional[str] = None) -> CredentialsGcp
    func GetCredentialsGcp(ctx *Context, name string, id IDInput, state *CredentialsGcpState, opts ...ResourceOption) (*CredentialsGcp, error)
    public static CredentialsGcp Get(string name, Input<string> id, CredentialsGcpState? state, CustomResourceOptions? opts = null)
    public static CredentialsGcp get(String name, Output<String> id, CredentialsGcpState 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:
    AccountId string
    The ID of the account associated with your token.
    AuthProviderX509CertUrl string
    .
    AuthUri string
    Authentication uri.
    ClientEmail string
    Email associated with service account.
    ClientId string
    Client ID of service account.
    ClientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    PrivateKey string
    Private key of JSON key created during prerequisites stage.
    PrivateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    ProjectId string
    Name of project in GCP.
    TokenUri string
    Token uri.
    Type string
    Valid values - service_account.
    AccountId string
    The ID of the account associated with your token.
    AuthProviderX509CertUrl string
    .
    AuthUri string
    Authentication uri.
    ClientEmail string
    Email associated with service account.
    ClientId string
    Client ID of service account.
    ClientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    PrivateKey string
    Private key of JSON key created during prerequisites stage.
    PrivateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    ProjectId string
    Name of project in GCP.
    TokenUri string
    Token uri.
    Type string
    Valid values - service_account.
    accountId String
    The ID of the account associated with your token.
    authProviderX509CertUrl String
    .
    authUri String
    Authentication uri.
    clientEmail String
    Email associated with service account.
    clientId String
    Client ID of service account.
    clientX509CertUrl String
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey String
    Private key of JSON key created during prerequisites stage.
    privateKeyId String
    Private key ID of JSON key created during prerequisites stage.
    projectId String
    Name of project in GCP.
    tokenUri String
    Token uri.
    type String
    Valid values - service_account.
    accountId string
    The ID of the account associated with your token.
    authProviderX509CertUrl string
    .
    authUri string
    Authentication uri.
    clientEmail string
    Email associated with service account.
    clientId string
    Client ID of service account.
    clientX509CertUrl string
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey string
    Private key of JSON key created during prerequisites stage.
    privateKeyId string
    Private key ID of JSON key created during prerequisites stage.
    projectId string
    Name of project in GCP.
    tokenUri string
    Token uri.
    type string
    Valid values - service_account.
    account_id str
    The ID of the account associated with your token.
    auth_provider_x509_cert_url str
    .
    auth_uri str
    Authentication uri.
    client_email str
    Email associated with service account.
    client_id str
    Client ID of service account.
    client_x509_cert_url str
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    private_key str
    Private key of JSON key created during prerequisites stage.
    private_key_id str
    Private key ID of JSON key created during prerequisites stage.
    project_id str
    Name of project in GCP.
    token_uri str
    Token uri.
    type str
    Valid values - service_account.
    accountId String
    The ID of the account associated with your token.
    authProviderX509CertUrl String
    .
    authUri String
    Authentication uri.
    clientEmail String
    Email associated with service account.
    clientId String
    Client ID of service account.
    clientX509CertUrl String
    Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/".
    privateKey String
    Private key of JSON key created during prerequisites stage.
    privateKeyId String
    Private key ID of JSON key created during prerequisites stage.
    projectId String
    Name of project in GCP.
    tokenUri String
    Token uri.
    type String
    Valid values - service_account.

    Package Details

    Repository
    Spotinst pulumi/pulumi-spotinst
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the spotinst Terraform Provider.
    spotinst logo
    Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi