README.md

ConfluentCloud::IAM::ServiceAccount

Service Account as defined in Confluent Cloud IAM v2 API.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "ConfluentCloud::IAM::ServiceAccount",
    "Properties" : {
        "Description" : String,
        "Name" : String,
        "ConfluentCloudCredentials" : ConfluentCloudAPISecrets
    }
}

YAML

Type: ConfluentCloud::IAM::ServiceAccount
Properties:
    Description: String
    Name: String
    ConfluentCloudCredentials: ConfluentCloudAPISecrets

Properties

Description

The description associated with the Service Account

Required: No

Type: String

Pattern: ^[\x20-\x7E]+$

Update requires: No interruption

Name

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-_.]+$

Update requires: Replacement

ConfluentCloudCredentials

Required: Yes

Type: ConfluentCloudAPISecrets

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ServiceAccountId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ServiceAccountId

Service Account in Confluent Cloud (sa-xxxx)