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.89.1 published on Sunday, Mar 2, 2025 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.89.1 published on Sunday, Mar 2, 2025 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)
public static Output<GetSecretsManagerSecretResult> getSecretsManagerSecret(GetSecretsManagerSecretArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:awsconnector:getSecretsManagerSecret
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- Name of SecretsManagerSecret
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Name string
- Name of SecretsManagerSecret
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- name String
- Name of SecretsManagerSecret
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- name string
- Name of SecretsManagerSecret
- resourceGroup 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
- resourceGroup 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.
- SystemData 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
SecretsManager Secret Properties Response 
- The resource-specific properties for this resource.
- SystemData 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
SecretsManager Secret Properties Response 
- The resource-specific properties for this resource.
- systemData 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
SecretsManager Secret Properties Response 
- The resource-specific properties for this resource.
- systemData 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
SecretsManager 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.
- systemData 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.
- GenerateSecret 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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
- KmsKey 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/secretsmanagerto 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.
- ReplicaRegions List<Pulumi.Azure Native. Aws Connector. Inputs. Replica Region Response> 
- A custom type that specifies a Regionand theKmsKeyIdfor a replica secret.
- SecretString 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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 Deniederror. 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.
- GenerateSecret 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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
- KmsKey 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/secretsmanagerto 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.
- ReplicaRegions []ReplicaRegion Response 
- A custom type that specifies a Regionand theKmsKeyIdfor a replica secret.
- SecretString 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
- 
[]TagResponse 
- 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 Deniederror. 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.
- generateSecret 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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
- kmsKey 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/secretsmanagerto 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.
- replicaRegions List<ReplicaRegion Response> 
- A custom type that specifies a Regionand theKmsKeyIdfor a replica secret.
- secretString 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
- 
List<TagResponse> 
- 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 Deniederror. 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.
- generateSecret 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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
- kmsKey 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/secretsmanagerto 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.
- replicaRegions ReplicaRegion Response[] 
- A custom type that specifies a Regionand theKmsKeyIdfor a replica secret.
- secretString 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
- 
TagResponse[] 
- 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 Deniederror. 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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/secretsmanagerto 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 Regionand theKmsKeyIdfor 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, you create an empty secret. When you make a change to this property, a new secret version is created.
- 
Sequence[TagResponse] 
- 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 Deniederror. 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.
- generateSecret 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 SecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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
- kmsKey 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/secretsmanagerto 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.
- replicaRegions List<Property Map>
- A custom type that specifies a Regionand theKmsKeyIdfor a replica secret.
- secretString 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 GenerateSecretStringinstead. If you omit bothGenerateSecretStringandSecretString, 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 Deniederror. 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   
- ExcludeCharacters string
- A string of the characters that you don't want in the password.
- ExcludeLowercase bool
- Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- ExcludeNumbers bool
- Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- ExcludePunctuation bool
- Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
- ExcludeUppercase bool
- Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- GenerateString 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 SecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.
- IncludeSpace bool
- Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- PasswordLength int
- The length of the password. If you don't include this parameter, the default length is 32 characters.
- RequireEach 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.
- SecretString stringTemplate 
- A template that the generated string must match. When you make a change to this property, a new secret version is created.
- ExcludeCharacters string
- A string of the characters that you don't want in the password.
- ExcludeLowercase bool
- Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- ExcludeNumbers bool
- Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- ExcludePunctuation bool
- Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
- ExcludeUppercase bool
- Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- GenerateString 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 SecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.
- IncludeSpace bool
- Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- PasswordLength int
- The length of the password. If you don't include this parameter, the default length is 32 characters.
- RequireEach 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.
- SecretString stringTemplate 
- A template that the generated string must match. When you make a change to this property, a new secret version is created.
- excludeCharacters String
- A string of the characters that you don't want in the password.
- excludeLowercase Boolean
- Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- excludeNumbers Boolean
- Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- excludePunctuation Boolean
- Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
- excludeUppercase Boolean
- Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generateString 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 SecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.
- includeSpace Boolean
- Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- passwordLength Integer
- The length of the password. If you don't include this parameter, the default length is 32 characters.
- requireEach 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.
- secretString StringTemplate 
- A template that the generated string must match. When you make a change to this property, a new secret version is created.
- excludeCharacters string
- A string of the characters that you don't want in the password.
- excludeLowercase boolean
- Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- excludeNumbers boolean
- Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- excludePunctuation boolean
- Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
- excludeUppercase boolean
- Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generateString 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 SecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.
- includeSpace boolean
- Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- passwordLength number
- The length of the password. If you don't include this parameter, the default length is 32 characters.
- requireEach 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.
- secretString 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 SecretStringTemplateparameter. 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.
- excludeCharacters String
- A string of the characters that you don't want in the password.
- excludeLowercase Boolean
- Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
- excludeNumbers Boolean
- Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
- excludePunctuation Boolean
- Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this switch, the password can contain punctuation.
- excludeUppercase Boolean
- Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
- generateString 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 SecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.
- includeSpace Boolean
- Specifies whether to include the space character. If you include this switch, the password can contain space characters.
- passwordLength Number
- The length of the password. If you don't include this parameter, the default length is 32 characters.
- requireEach 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.
- secretString 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    
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties Pulumi.Azure Native. Aws Connector. Inputs. Aws Secrets Manager Secret Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties AwsSecrets Manager Secret Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- map[string]string
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties AwsSecrets Manager Secret Properties Response 
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String,String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
- provisioningState string
- The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- awsAccount stringId 
- AWS Account ID
- awsProperties AwsSecrets Manager Secret Properties Response 
- AWS Properties
- awsRegion string
- AWS Region
- awsSource stringSchema 
- AWS Source Schema
- {[key: string]: string}
- AWS Tags
- publicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud 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
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties Property Map
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
SystemDataResponse  
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified 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.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified 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.89.1 published on Sunday, Mar 2, 2025 by Pulumi