This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.awsconnector.getSecretsManagerSecret
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Get a SecretsManagerSecret Azure REST API version: 2024-12-01.
Using getSecretsManagerSecret
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSecretsManagerSecret(args: GetSecretsManagerSecretArgs, opts?: InvokeOptions): Promise<GetSecretsManagerSecretResult>
function getSecretsManagerSecretOutput(args: GetSecretsManagerSecretOutputArgs, opts?: InvokeOptions): Output<GetSecretsManagerSecretResult>
def get_secrets_manager_secret(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSecretsManagerSecretResult
def get_secrets_manager_secret_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSecretsManagerSecretResult]
func LookupSecretsManagerSecret(ctx *Context, args *LookupSecretsManagerSecretArgs, opts ...InvokeOption) (*LookupSecretsManagerSecretResult, error)
func LookupSecretsManagerSecretOutput(ctx *Context, args *LookupSecretsManagerSecretOutputArgs, opts ...InvokeOption) LookupSecretsManagerSecretResultOutput
> Note: This function is named LookupSecretsManagerSecret
in the Go SDK.
public static class GetSecretsManagerSecret
{
public static Task<GetSecretsManagerSecretResult> InvokeAsync(GetSecretsManagerSecretArgs args, InvokeOptions? opts = null)
public static Output<GetSecretsManagerSecretResult> Invoke(GetSecretsManagerSecretInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSecretsManagerSecretResult> getSecretsManagerSecret(GetSecretsManagerSecretArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:awsconnector:getSecretsManagerSecret
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of SecretsManagerSecret
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Name string
- Name of SecretsManagerSecret
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- name String
- Name of SecretsManagerSecret
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- name string
- Name of SecretsManagerSecret
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- name str
- Name of SecretsManagerSecret
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- name String
- Name of SecretsManagerSecret
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getSecretsManagerSecret Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Aws Connector. Outputs. Secrets Manager Secret Properties Response - The resource-specific properties for this resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Dictionary<string, string>
- Resource tags.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Properties
Secrets
Manager Secret Properties Response - The resource-specific properties for this resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- map[string]string
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties
Secrets
Manager Secret Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Map<String,String>
- Resource tags.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- properties
Secrets
Manager Secret Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- {[key: string]: string}
- Resource tags.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- properties
Secrets
Manager Secret Properties Response - The resource-specific properties for this resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Mapping[str, str]
- Resource tags.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- properties Property Map
- The resource-specific properties for this resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Map<String>
- Resource tags.
Supporting Types
AwsSecretsManagerSecretPropertiesResponse
- Description string
- The description of the secret.
- Generate
Secret Pulumi.String Azure Native. Aws Connector. Inputs. Generate Secret String Response - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - Id string
- Property id
- Kms
Key stringId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - Name string
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- Replica
Regions List<Pulumi.Azure Native. Aws Connector. Inputs. Replica Region Response> - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - Secret
String string - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
- Description string
- The description of the secret.
- Generate
Secret GenerateString Secret String Response - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - Id string
- Property id
- Kms
Key stringId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - Name string
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- Replica
Regions []ReplicaRegion Response - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - Secret
String string - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - []Tag
Response - 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
- description String
- The description of the secret.
- generate
Secret GenerateString Secret String Response - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - id String
- Property id
- kms
Key StringId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - name String
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- replica
Regions List<ReplicaRegion Response> - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - secret
String String - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - List<Tag
Response> - 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
- description string
- The description of the secret.
- generate
Secret GenerateString Secret String Response - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - id string
- Property id
- kms
Key stringId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - name string
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- replica
Regions ReplicaRegion Response[] - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - secret
String string - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - Tag
Response[] - 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
- description str
- The description of the secret.
- generate_
secret_ Generatestring Secret String Response - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - id str
- Property id
- kms_
key_ strid - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - name str
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- replica_
regions Sequence[ReplicaRegion Response] - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - secret_
string str - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - Sequence[Tag
Response] - 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
- description String
- The description of the secret.
- generate
Secret Property MapString - A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions:secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. - id String
- Property id
- kms
Key StringId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key. - name String
- The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- replica
Regions List<Property Map> - A custom type that specifies a
Region
and theKmsKeyId
for a replica secret. - secret
String String - The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. - List<Property Map>
- 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'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. 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 anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. 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 theaws:
prefix in your tag names or values because AWS reserves it for AWS 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: + - = . _ : / @.
GenerateSecretStringResponse
- Exclude
Characters string - A string of the characters that you don't want in the password.
- Exclude
Lowercase bool - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- Exclude
Numbers bool - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- Exclude
Punctuation bool - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - Exclude
Uppercase bool - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- Generate
String stringKey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - Include
Space bool - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- Password
Length int - The length of the password. If you don't include this parameter, the default length is 32 characters.
- Require
Each boolIncluded Type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- Secret
String stringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
- Exclude
Characters string - A string of the characters that you don't want in the password.
- Exclude
Lowercase bool - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- Exclude
Numbers bool - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- Exclude
Punctuation bool - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - Exclude
Uppercase bool - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- Generate
String stringKey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - Include
Space bool - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- Password
Length int - The length of the password. If you don't include this parameter, the default length is 32 characters.
- Require
Each boolIncluded Type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- Secret
String stringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
- exclude
Characters String - A string of the characters that you don't want in the password.
- exclude
Lowercase Boolean - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- exclude
Numbers Boolean - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- exclude
Punctuation Boolean - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - exclude
Uppercase Boolean - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generate
String StringKey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - include
Space Boolean - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- password
Length Integer - The length of the password. If you don't include this parameter, the default length is 32 characters.
- require
Each BooleanIncluded Type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- secret
String StringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
- exclude
Characters string - A string of the characters that you don't want in the password.
- exclude
Lowercase boolean - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- exclude
Numbers boolean - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- exclude
Punctuation boolean - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - exclude
Uppercase boolean - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generate
String stringKey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - include
Space boolean - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- password
Length number - The length of the password. If you don't include this parameter, the default length is 32 characters.
- require
Each booleanIncluded Type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- secret
String stringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
- exclude_
characters str - A string of the characters that you don't want in the password.
- exclude_
lowercase bool - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- exclude_
numbers bool - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- exclude_
punctuation bool - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - exclude_
uppercase bool - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generate_
string_ strkey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - include_
space bool - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- password_
length int - The length of the password. If you don't include this parameter, the default length is 32 characters.
- require_
each_ boolincluded_ type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- secret_
string_ strtemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
- exclude
Characters String - A string of the characters that you don't want in the password.
- exclude
Lowercase Boolean - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- exclude
Numbers Boolean - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- exclude
Punctuation Boolean - Specifies whether to exclude the following punctuation characters from the password:
! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation. - exclude
Uppercase Boolean - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generate
String StringKey - The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
. - include
Space Boolean - Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- password
Length Number - The length of the password. If you don't include this parameter, the default length is 32 characters.
- require
Each BooleanIncluded Type - Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
- secret
String StringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.
ReplicaRegionResponse
- kms_
key_ strid - The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses
aws/secretsmanager
. - region str
- A string that represents a
Region
, for example 'us-east-1'.
SecretsManagerSecretPropertiesResponse
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Secrets Manager Secret Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsSecrets Manager Secret Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsSecrets Manager Secret Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsSecrets Manager Secret Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsSecrets Manager Secret Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TagResponse
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi