Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.38.0
Secret
secretsmanager.aws.crossplane.io
Secret
crossplane-contrib/provider-aws@v0.38.0secretsmanager.aws.crossplane.io

Secret is the Schema for the Secrets API

Type

CRD

Group

secretsmanager.aws.crossplane.io

Version

apiVersion: secretsmanager.aws.crossplane.io/v1beta1

kind: Secret

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

SecretSpec defines the desired state of Secret

forProvider
requiredobject
requiredobject

SecretParameters defines the desired state of Secret

array

A list of Regions and KMS keys to replicate secrets.

kmsKeyID
string
region
string
object

BinarySecretRef points to the Kubernetes Secret whose data will be encoded as binary data to AWS. If key parameter is given, only the value of that key will be used. Otherwise, all data in the Secret will be marshalled into JSON and sent to AWS. Either StringSecretRef or BinarySecretRef must be set, but not both.

key
string
name
requiredstring
namespace
requiredstring
type
string
kmsKeyID
string
object

KMSKeyIDRef is a reference to an kms/v1alpha1.Key used to set the KMSKeyID field.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

KMSKeyIDSelector selects references to kms/v1alpha1.Key used to set the KMSKeyID.

policy
object
object

Policies for selection.

resolve
string
region
requiredstring
object

StringSecretRef points to the Kubernetes Secret whose data will be sent as string to AWS. If key parameter is given, only the value of that key will be used. Otherwise, all data in the Secret will be marshalled into JSON and sent to AWS. Either StringSecretRef or BinarySecretRef must be set, but not both.

key
string
name
requiredstring
namespace
requiredstring
type
string
tags
array
array

A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}] Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and Limit access to identities with tags that match secrets' tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags:

  • Maximum number of tags per secret: 50
  • Maximum key length: 127 Unicode characters in UTF-8
  • Maximum value length: 255 Unicode characters in UTF-8
  • Tag keys and values are case sensitive.
  • Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
  • If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
key
string
value
string
object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

SecretStatus defines the observed state of Secret.

object

SecretObservation defines the observed state of Secret

arn
string
array

A list of the replicas of this secret and their status:

  • Failed, which indicates that the replica was not created.
  • InProgress, which indicates that Secrets Manager is in the process of creating the replica.
  • InSync, which indicates that the replica was created.
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.