Bicep resource definition
The secretsManagerSecrets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/secretsManagerSecrets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/secretsManagerSecrets@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
description: 'string'
generateSecretString: {
excludeCharacters: 'string'
excludeLowercase: bool
excludeNumbers: bool
excludePunctuation: bool
excludeUppercase: bool
generateStringKey: 'string'
includeSpace: bool
passwordLength: int
requireEachIncludedType: bool
secretStringTemplate: 'string'
}
id: 'string'
kmsKeyId: 'string'
name: 'string'
replicaRegions: [
{
kmsKeyId: 'string'
region: 'string'
}
]
secretString: 'string'
tags: [
{
key: 'string'
value: 'string'
}
]
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/secretsManagerSecrets
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
SecretsManagerSecretProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AwsSecretsManagerSecretProperties
| Name |
Description |
Value |
| description |
The description of the secret. |
string |
| generateSecretString |
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 both GenerateSecretString and SecretString, 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. |
GenerateSecretString |
| id |
Property id |
string |
| kmsKeyId |
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 example alias/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 key aws/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 use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key. |
string |
| name |
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. |
string |
| replicaRegions |
A custom type that specifies a Region and the KmsKeyId for a replica secret. |
ReplicaRegion[] |
| secretString |
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 both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created. |
string |
| tags |
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 an Access 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 the aws: 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: + - = . _ : / @. |
TagAutoGenerated52[] |
GenerateSecretString
| Name |
Description |
Value |
| excludeCharacters |
A string of the characters that you don't want in the password. |
string |
| excludeLowercase |
Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters. |
bool |
| excludeNumbers |
Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. |
bool |
| excludePunctuation |
Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~. If you don't include this switch, the password can contain punctuation. |
bool |
| excludeUppercase |
Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters. |
bool |
| generateStringKey |
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 specify SecretStringTemplate. |
string |
| includeSpace |
Specifies whether to include the space character. If you include this switch, the password can contain space characters. |
bool |
| passwordLength |
The length of the password. If you don't include this parameter, the default length is 32 characters. |
int |
| requireEachIncludedType |
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. |
bool |
| secretStringTemplate |
A template that the generated string must match. When you make a change to this property, a new secret version is created. |
string |
ReplicaRegion
| Name |
Description |
Value |
| kmsKeyId |
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. |
string |
| region |
A string that represents a Region, for example 'us-east-1'. |
string |
SecretsManagerSecretProperties
| Name |
Description |
Value |
| arn |
Amazon Resource Name (ARN) |
string |
| awsAccountId |
AWS Account ID |
string |
| awsProperties |
AWS Properties |
AwsSecretsManagerSecretProperties |
| awsRegion |
AWS Region |
string |
| awsSourceSchema |
AWS Source Schema |
string |
| awsTags |
AWS Tags |
SecretsManagerSecretPropertiesAwsTags |
| publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
| publicCloudResourceName |
Public Cloud Resource Name |
string |
TagAutoGenerated52
| Name |
Description |
Value |
| key |
The key identifier, or name, of the tag. |
string |
| value |
The string value associated with the key of the tag. |
string |
ARM template resource definition
The secretsManagerSecrets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/secretsManagerSecrets resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/secretsManagerSecrets",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"description": "string",
"generateSecretString": {
"excludeCharacters": "string",
"excludeLowercase": "bool",
"excludeNumbers": "bool",
"excludePunctuation": "bool",
"excludeUppercase": "bool",
"generateStringKey": "string",
"includeSpace": "bool",
"passwordLength": "int",
"requireEachIncludedType": "bool",
"secretStringTemplate": "string"
},
"id": "string",
"kmsKeyId": "string",
"name": "string",
"replicaRegions": [
{
"kmsKeyId": "string",
"region": "string"
}
],
"secretString": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/secretsManagerSecrets
| Name |
Description |
Value |
| apiVersion |
The api version |
'2024-12-01' |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
SecretsManagerSecretProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.AwsConnector/secretsManagerSecrets' |
AwsSecretsManagerSecretProperties
| Name |
Description |
Value |
| description |
The description of the secret. |
string |
| generateSecretString |
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 both GenerateSecretString and SecretString, 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. |
GenerateSecretString |
| id |
Property id |
string |
| kmsKeyId |
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 example alias/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 key aws/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 use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key. |
string |
| name |
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. |
string |
| replicaRegions |
A custom type that specifies a Region and the KmsKeyId for a replica secret. |
ReplicaRegion[] |
| secretString |
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 both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created. |
string |
| tags |
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 an Access 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 the aws: 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: + - = . _ : / @. |
TagAutoGenerated52[] |
GenerateSecretString
| Name |
Description |
Value |
| excludeCharacters |
A string of the characters that you don't want in the password. |
string |
| excludeLowercase |
Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters. |
bool |
| excludeNumbers |
Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. |
bool |
| excludePunctuation |
Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~. If you don't include this switch, the password can contain punctuation. |
bool |
| excludeUppercase |
Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters. |
bool |
| generateStringKey |
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 specify SecretStringTemplate. |
string |
| includeSpace |
Specifies whether to include the space character. If you include this switch, the password can contain space characters. |
bool |
| passwordLength |
The length of the password. If you don't include this parameter, the default length is 32 characters. |
int |
| requireEachIncludedType |
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. |
bool |
| secretStringTemplate |
A template that the generated string must match. When you make a change to this property, a new secret version is created. |
string |
ReplicaRegion
| Name |
Description |
Value |
| kmsKeyId |
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. |
string |
| region |
A string that represents a Region, for example 'us-east-1'. |
string |
SecretsManagerSecretProperties
| Name |
Description |
Value |
| arn |
Amazon Resource Name (ARN) |
string |
| awsAccountId |
AWS Account ID |
string |
| awsProperties |
AWS Properties |
AwsSecretsManagerSecretProperties |
| awsRegion |
AWS Region |
string |
| awsSourceSchema |
AWS Source Schema |
string |
| awsTags |
AWS Tags |
SecretsManagerSecretPropertiesAwsTags |
| publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
| publicCloudResourceName |
Public Cloud Resource Name |
string |
TagAutoGenerated52
| Name |
Description |
Value |
| key |
The key identifier, or name, of the tag. |
string |
| value |
The string value associated with the key of the tag. |
string |
Usage Examples
The secretsManagerSecrets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AwsConnector/secretsManagerSecrets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/secretsManagerSecrets@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
description = "string"
generateSecretString = {
excludeCharacters = "string"
excludeLowercase = bool
excludeNumbers = bool
excludePunctuation = bool
excludeUppercase = bool
generateStringKey = "string"
includeSpace = bool
passwordLength = int
requireEachIncludedType = bool
secretStringTemplate = "string"
}
id = "string"
kmsKeyId = "string"
name = "string"
replicaRegions = [
{
kmsKeyId = "string"
region = "string"
}
]
secretString = "string"
tags = [
{
key = "string"
value = "string"
}
]
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/secretsManagerSecrets
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string
Constraints:
Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties |
The resource-specific properties for this resource. |
SecretsManagerSecretProperties |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.AwsConnector/secretsManagerSecrets@2024-12-01" |
AwsSecretsManagerSecretProperties
| Name |
Description |
Value |
| description |
The description of the secret. |
string |
| generateSecretString |
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 both GenerateSecretString and SecretString, 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. |
GenerateSecretString |
| id |
Property id |
string |
| kmsKeyId |
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 example alias/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 key aws/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 use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key. |
string |
| name |
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. |
string |
| replicaRegions |
A custom type that specifies a Region and the KmsKeyId for a replica secret. |
ReplicaRegion[] |
| secretString |
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 both GenerateSecretString and SecretString, you create an empty secret. When you make a change to this property, a new secret version is created. |
string |
| tags |
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 an Access 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 the aws: 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: + - = . _ : / @. |
TagAutoGenerated52[] |
GenerateSecretString
| Name |
Description |
Value |
| excludeCharacters |
A string of the characters that you don't want in the password. |
string |
| excludeLowercase |
Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters. |
bool |
| excludeNumbers |
Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. |
bool |
| excludePunctuation |
Specifies whether to exclude the following punctuation characters from the password: ! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { \| } ~. If you don't include this switch, the password can contain punctuation. |
bool |
| excludeUppercase |
Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters. |
bool |
| generateStringKey |
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 specify SecretStringTemplate. |
string |
| includeSpace |
Specifies whether to include the space character. If you include this switch, the password can contain space characters. |
bool |
| passwordLength |
The length of the password. If you don't include this parameter, the default length is 32 characters. |
int |
| requireEachIncludedType |
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. |
bool |
| secretStringTemplate |
A template that the generated string must match. When you make a change to this property, a new secret version is created. |
string |
ReplicaRegion
| Name |
Description |
Value |
| kmsKeyId |
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. |
string |
| region |
A string that represents a Region, for example 'us-east-1'. |
string |
SecretsManagerSecretProperties
| Name |
Description |
Value |
| arn |
Amazon Resource Name (ARN) |
string |
| awsAccountId |
AWS Account ID |
string |
| awsProperties |
AWS Properties |
AwsSecretsManagerSecretProperties |
| awsRegion |
AWS Region |
string |
| awsSourceSchema |
AWS Source Schema |
string |
| awsTags |
AWS Tags |
SecretsManagerSecretPropertiesAwsTags |
| publicCloudConnectorsResourceId |
Public Cloud Connectors Resource ID |
string |
| publicCloudResourceName |
Public Cloud Resource Name |
string |
TagAutoGenerated52
| Name |
Description |
Value |
| key |
The key identifier, or name, of the tag. |
string |
| value |
The string value associated with the key of the tag. |
string |