pulumibackendcredentialv1

package
v0.0.32 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	PulumiBackendType_name = map[int32]string{
		0: "pulumi_backend_type_unspecified",
		1: "local_file_system",
		2: "http",
		3: "aws_s3",
		4: "google_cloud_storage",
		5: "azure_blob_storage",
	}
	PulumiBackendType_value = map[string]int32{
		"pulumi_backend_type_unspecified": 0,
		"local_file_system":               1,
		"http":                            2,
		"aws_s3":                          3,
		"google_cloud_storage":            4,
		"azure_blob_storage":              5,
	}
)

Enum value maps for PulumiBackendType.

View Source 
var File_project_planton_credential_pulumibackendcredential_v1_api_proto protoreflect.FileDescriptor
View Source 
var File_project_planton_credential_pulumibackendcredential_v1_spec_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type PulumiAwsS3Backend 

type PulumiAwsS3Backend struct {

	// name of s3-bucket
	S3Bucket string `protobuf:"bytes,1,opt,name=s3_bucket,json=s3Bucket,proto3" json:"s3_bucket,omitempty"`
	// aws-access-key-id
	AwsAccessKeyId string `protobuf:"bytes,2,opt,name=aws_access_key_id,json=awsAccessKeyId,proto3" json:"aws_access_key_id,omitempty"`
	// aws-secret-key-id
	AwsSecretKeyId string `protobuf:"bytes,3,opt,name=aws_secret_key_id,json=awsSecretKeyId,proto3" json:"aws_secret_key_id,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential spec for aws-s3 backend https://www.pulumi.com/docs/concepts/state/#aws-s3 Consider adding a note about the IAM roles or policies required to access the S3 bucket securely.

func (*PulumiAwsS3Backend) Descriptor deprecated 

func (*PulumiAwsS3Backend) Descriptor() ([]byte, []int)

Deprecated: Use PulumiAwsS3Backend.ProtoReflect.Descriptor instead.

func (*PulumiAwsS3Backend) GetAwsAccessKeyId 

func (x *PulumiAwsS3Backend) GetAwsAccessKeyId() string

func (*PulumiAwsS3Backend) GetAwsSecretKeyId 

func (x *PulumiAwsS3Backend) GetAwsSecretKeyId() string

func (*PulumiAwsS3Backend) GetS3Bucket 

func (x *PulumiAwsS3Backend) GetS3Bucket() string

func (*PulumiAwsS3Backend) ProtoMessage 

func (*PulumiAwsS3Backend) ProtoMessage()

func (*PulumiAwsS3Backend) ProtoReflect 

func (x *PulumiAwsS3Backend) ProtoReflect() protoreflect.Message

func (*PulumiAwsS3Backend) Reset 

func (x *PulumiAwsS3Backend) Reset()

func (*PulumiAwsS3Backend) String 

func (x *PulumiAwsS3Backend) String() string

type PulumiAzureBlobStorageBackend 

type PulumiAzureBlobStorageBackend struct {

	// name of azure blob storage container
	BlobStorageContainer string `protobuf:"bytes,1,opt,name=blob_storage_container,json=blobStorageContainer,proto3" json:"blob_storage_container,omitempty"`
	// azure storage-account-name
	StorageAccountName string `protobuf:"bytes,2,opt,name=storage_account_name,json=storageAccountName,proto3" json:"storage_account_name,omitempty"`
	// azure storage-account-key
	StorageAccountKey string `protobuf:"bytes,3,opt,name=storage_account_key,json=storageAccountKey,proto3" json:"storage_account_key,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential spec for azure-blob-storage backend https://www.pulumi.com/docs/concepts/state/#azure-blob-storage Provide a note on the importance of securing the storage account key and potential alternatives, like using Azure Key Vault.

func (*PulumiAzureBlobStorageBackend) Descriptor deprecated 

func (*PulumiAzureBlobStorageBackend) Descriptor() ([]byte, []int)

Deprecated: Use PulumiAzureBlobStorageBackend.ProtoReflect.Descriptor instead.

func (*PulumiAzureBlobStorageBackend) GetBlobStorageContainer 

func (x *PulumiAzureBlobStorageBackend) GetBlobStorageContainer() string

func (*PulumiAzureBlobStorageBackend) GetStorageAccountKey 

func (x *PulumiAzureBlobStorageBackend) GetStorageAccountKey() string

func (*PulumiAzureBlobStorageBackend) GetStorageAccountName 

func (x *PulumiAzureBlobStorageBackend) GetStorageAccountName() string

func (*PulumiAzureBlobStorageBackend) ProtoMessage 

func (*PulumiAzureBlobStorageBackend) ProtoMessage()

func (*PulumiAzureBlobStorageBackend) ProtoReflect 

func (x *PulumiAzureBlobStorageBackend) ProtoReflect() protoreflect.Message

func (*PulumiAzureBlobStorageBackend) Reset 

func (x *PulumiAzureBlobStorageBackend) Reset()

func (*PulumiAzureBlobStorageBackend) String 

func (x *PulumiAzureBlobStorageBackend) String() string

type PulumiBackendCredential 

type PulumiBackendCredential struct {

	// api-version
	ApiVersion string `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// resource-kind
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// metadata
	Metadata *shared.ApiResourceMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// spec
	Spec *PulumiBackendCredentialSpec `protobuf:"bytes,4,opt,name=spec,proto3" json:"spec,omitempty"`
	// status
	Status *shared.ApiResourceLifecycleAndAuditStatus `protobuf:"bytes,5,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential

func (*PulumiBackendCredential) Descriptor deprecated 

func (*PulumiBackendCredential) Descriptor() ([]byte, []int)

Deprecated: Use PulumiBackendCredential.ProtoReflect.Descriptor instead.

func (*PulumiBackendCredential) GetApiVersion 

func (x *PulumiBackendCredential) GetApiVersion() string

func (*PulumiBackendCredential) GetKind 

func (x *PulumiBackendCredential) GetKind() string

func (*PulumiBackendCredential) GetMetadata 

func (x *PulumiBackendCredential) GetMetadata() *shared.ApiResourceMetadata

func (*PulumiBackendCredential) GetSpec 

func (x *PulumiBackendCredential) GetSpec() *PulumiBackendCredentialSpec

func (*PulumiBackendCredential) GetStatus 

func (x *PulumiBackendCredential) GetStatus() *shared.ApiResourceLifecycleAndAuditStatus

func (*PulumiBackendCredential) ProtoMessage 

func (*PulumiBackendCredential) ProtoMessage()

func (*PulumiBackendCredential) ProtoReflect 

func (x *PulumiBackendCredential) ProtoReflect() protoreflect.Message

func (*PulumiBackendCredential) Reset 

func (x *PulumiBackendCredential) Reset()

func (*PulumiBackendCredential) String 

func (x *PulumiBackendCredential) String() string

type PulumiBackendCredentialSpec 

type PulumiBackendCredentialSpec struct {

	// The provider for the Pulumi backend credential.
	// This field specifies the type of backend used to store Pulumi state (e.g., local file system, AWS S3, Google Cloud Storage).
	// For more information, refer to: https://www.pulumi.com/docs/concepts/state
	// Each backend type has different use cases; for example, local backends are suitable for development, while cloud backends are ideal for scalable, team-based environments.
	// Properly selecting the backend type is crucial for ensuring that the infrastructure state is managed efficiently and securely, depending on the project requirements and team setup.
	PulumiBackendType PulumiBackendType `` /* 192-byte string literal not displayed */
	// local-file-system backend spec
	LocalFileSystem *PulumiLocalFileSystemBackend `protobuf:"bytes,2,opt,name=local_file_system,json=localFileSystem,proto3" json:"local_file_system,omitempty"`
	// http backend spec
	Http *PulumiHttpBackend `protobuf:"bytes,3,opt,name=http,proto3" json:"http,omitempty"`
	// aws-s3 backend spec
	AwsS3 *PulumiAwsS3Backend `protobuf:"bytes,4,opt,name=aws_s3,json=awsS3,proto3" json:"aws_s3,omitempty"`
	// google-cloud-storage backend spec
	GoogleCloudStorage *PulumiGoogleCloudStorageBackend `protobuf:"bytes,5,opt,name=google_cloud_storage,json=googleCloudStorage,proto3" json:"google_cloud_storage,omitempty"`
	// azure-blob-storage backend spec
	AzureBlobStorage *PulumiAzureBlobStorageBackend `protobuf:"bytes,6,opt,name=azure_blob_storage,json=azureBlobStorage,proto3" json:"azure_blob_storage,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential spec These credentials are used for managing Pulumi state storage, which can be configured for different cloud providers or local environments. For example, these credentials can be used to store state files in AWS S3, Google Cloud Storage, Azure Blob Storage, or locally on the file system. Properly configuring these backends is essential for managing and maintaining infrastructure state efficiently.

func (*PulumiBackendCredentialSpec) Descriptor deprecated 

func (*PulumiBackendCredentialSpec) Descriptor() ([]byte, []int)

Deprecated: Use PulumiBackendCredentialSpec.ProtoReflect.Descriptor instead.

func (*PulumiBackendCredentialSpec) GetAwsS3 

func (x *PulumiBackendCredentialSpec) GetAwsS3() *PulumiAwsS3Backend

func (*PulumiBackendCredentialSpec) GetAzureBlobStorage 

func (x *PulumiBackendCredentialSpec) GetAzureBlobStorage() *PulumiAzureBlobStorageBackend

func (*PulumiBackendCredentialSpec) GetGoogleCloudStorage 

func (x *PulumiBackendCredentialSpec) GetGoogleCloudStorage() *PulumiGoogleCloudStorageBackend

func (*PulumiBackendCredentialSpec) GetHttp 

func (x *PulumiBackendCredentialSpec) GetHttp() *PulumiHttpBackend

func (*PulumiBackendCredentialSpec) GetLocalFileSystem 

func (x *PulumiBackendCredentialSpec) GetLocalFileSystem() *PulumiLocalFileSystemBackend

func (*PulumiBackendCredentialSpec) GetPulumiBackendType 

func (x *PulumiBackendCredentialSpec) GetPulumiBackendType() PulumiBackendType

func (*PulumiBackendCredentialSpec) ProtoMessage 

func (*PulumiBackendCredentialSpec) ProtoMessage()

func (*PulumiBackendCredentialSpec) ProtoReflect 

func (x *PulumiBackendCredentialSpec) ProtoReflect() protoreflect.Message

func (*PulumiBackendCredentialSpec) Reset 

func (x *PulumiBackendCredentialSpec) Reset()

func (*PulumiBackendCredentialSpec) String 

func (x *PulumiBackendCredentialSpec) String() string

type PulumiBackendType 

type PulumiBackendType int32

https://www.pulumi.com/docs/concepts/state PulumiBackendType enum represents the various backends supported for storing Pulumi state. Each backend type has its own use cases and advantages depending on the project requirements. - local_file_system: Suitable for small projects or local development/testing environments. - http: A centralized backend provided by Pulumi for managing state across distributed teams. - aws_s3: AWS S3 can be used for scalable and reliable state storage, commonly used in AWS environments. - google_cloud_storage: GCP's storage solution for state files, ideal for projects hosted on Google Cloud. - azure_blob_storage: Azure Blob Storage for state storage, typically used for projects hosted on Microsoft Azure. 

const (
	PulumiBackendType_pulumi_backend_type_unspecified PulumiBackendType = 0
	PulumiBackendType_local_file_system               PulumiBackendType = 1
	PulumiBackendType_http                            PulumiBackendType = 2
	PulumiBackendType_aws_s3                          PulumiBackendType = 3
	PulumiBackendType_google_cloud_storage            PulumiBackendType = 4
	PulumiBackendType_azure_blob_storage              PulumiBackendType = 5
)

func (PulumiBackendType) Descriptor 

func (PulumiBackendType) Descriptor() protoreflect.EnumDescriptor

func (PulumiBackendType) Enum 

func (x PulumiBackendType) Enum() *PulumiBackendType

func (PulumiBackendType) EnumDescriptor deprecated 

func (PulumiBackendType) EnumDescriptor() ([]byte, []int)

Deprecated: Use PulumiBackendType.Descriptor instead.

func (PulumiBackendType) Number 

func (x PulumiBackendType) Number() protoreflect.EnumNumber

func (PulumiBackendType) String 

func (x PulumiBackendType) String() string

func (PulumiBackendType) Type 

func (PulumiBackendType) Type() protoreflect.EnumType

type PulumiGoogleCloudStorageBackend 

type PulumiGoogleCloudStorageBackend struct {

	// name of gcs-bucket
	GcsBucket string `protobuf:"bytes,1,opt,name=gcs_bucket,json=gcsBucket,proto3" json:"gcs_bucket,omitempty"`
	// base64 encoded gcp service-account-key json
	ServiceAccountKeyBase64 string `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

pulumi-backend-credential spec for google-cloud-storage backend https://www.pulumi.com/docs/concepts/state/#google-cloud-storage Mention the necessary roles or permissions needed for the GCP service account to interact with Google Cloud Storage.

func (*PulumiGoogleCloudStorageBackend) Descriptor deprecated 

func (*PulumiGoogleCloudStorageBackend) Descriptor() ([]byte, []int)

Deprecated: Use PulumiGoogleCloudStorageBackend.ProtoReflect.Descriptor instead.

func (*PulumiGoogleCloudStorageBackend) GetGcsBucket 

func (x *PulumiGoogleCloudStorageBackend) GetGcsBucket() string

func (*PulumiGoogleCloudStorageBackend) GetServiceAccountKeyBase64 added in v0.0.22 

func (x *PulumiGoogleCloudStorageBackend) GetServiceAccountKeyBase64() string

func (*PulumiGoogleCloudStorageBackend) ProtoMessage 

func (*PulumiGoogleCloudStorageBackend) ProtoMessage()

func (*PulumiGoogleCloudStorageBackend) ProtoReflect 

func (x *PulumiGoogleCloudStorageBackend) ProtoReflect() protoreflect.Message

func (*PulumiGoogleCloudStorageBackend) Reset 

func (x *PulumiGoogleCloudStorageBackend) Reset()

func (*PulumiGoogleCloudStorageBackend) String 

func (x *PulumiGoogleCloudStorageBackend) String() string

type PulumiHttpBackend 

type PulumiHttpBackend struct {

	// api base url
	// this will be https://api.pulumi.com for Hosted Pulumi Cloud
	ApiUrl string `protobuf:"bytes,1,opt,name=api_url,json=apiUrl,proto3" json:"api_url,omitempty"`
	// The name of the Pulumi organization that owns the resources.
	// This field is required and is used to identify the Pulumi organization under which the infrastructure is managed.
	// It is crucial for managing access control, resource ownership, and collaboration within the Pulumi ecosystem.
	// Properly setting the organization name helps ensure that resources are created and maintained under the correct organizational context.
	PulumiOrganization string `protobuf:"bytes,2,opt,name=pulumi_organization,json=pulumiOrganization,proto3" json:"pulumi_organization,omitempty"`
	// access token to be used for authorization
	AccessToken string `protobuf:"bytes,3,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential spec for http backend hosted http backend provided by Pulumi Inc is https://pulumi.cloud Clarify that the HTTP backend is a centralized solution that can be used for managing state across distributed teams, which may have specific security considerations.

func (*PulumiHttpBackend) Descriptor deprecated 

func (*PulumiHttpBackend) Descriptor() ([]byte, []int)

Deprecated: Use PulumiHttpBackend.ProtoReflect.Descriptor instead.

func (*PulumiHttpBackend) GetAccessToken 

func (x *PulumiHttpBackend) GetAccessToken() string

func (*PulumiHttpBackend) GetApiUrl 

func (x *PulumiHttpBackend) GetApiUrl() string

func (*PulumiHttpBackend) GetPulumiOrganization added in v0.0.22 

func (x *PulumiHttpBackend) GetPulumiOrganization() string

func (*PulumiHttpBackend) ProtoMessage 

func (*PulumiHttpBackend) ProtoMessage()

func (*PulumiHttpBackend) ProtoReflect 

func (x *PulumiHttpBackend) ProtoReflect() protoreflect.Message

func (*PulumiHttpBackend) Reset 

func (x *PulumiHttpBackend) Reset()

func (*PulumiHttpBackend) String 

func (x *PulumiHttpBackend) String() string

type PulumiLocalFileSystemBackend 

type PulumiLocalFileSystemBackend struct {

	// state-file path
	StateFilePath string `protobuf:"bytes,1,opt,name=state_file_path,json=stateFilePath,proto3" json:"state_file_path,omitempty"`
	// contains filtered or unexported fields
}

pulumi-backend-credential spec for local-file-system backend https://www.pulumi.com/docs/concepts/state/#local-filesystem Mention that the local file system backend is typically used for smaller projects or testing purposes to help users understand its limitations.

func (*PulumiLocalFileSystemBackend) Descriptor deprecated 

func (*PulumiLocalFileSystemBackend) Descriptor() ([]byte, []int)

Deprecated: Use PulumiLocalFileSystemBackend.ProtoReflect.Descriptor instead.

func (*PulumiLocalFileSystemBackend) GetStateFilePath 

func (x *PulumiLocalFileSystemBackend) GetStateFilePath() string

func (*PulumiLocalFileSystemBackend) ProtoMessage 

func (*PulumiLocalFileSystemBackend) ProtoMessage()

func (*PulumiLocalFileSystemBackend) ProtoReflect 

func (x *PulumiLocalFileSystemBackend) ProtoReflect() protoreflect.Message

func (*PulumiLocalFileSystemBackend) Reset 

func (x *PulumiLocalFileSystemBackend) Reset()

func (*PulumiLocalFileSystemBackend) String 

func (x *PulumiLocalFileSystemBackend) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.