Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rocketmq
  6. getAccessKey
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.getAccessKey

volcenginecc logo
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::RocketMQ::AccessKey

    Using getAccessKey

    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 getAccessKey(args: GetAccessKeyArgs, opts?: InvokeOptions): Promise<GetAccessKeyResult>
function getAccessKeyOutput(args: GetAccessKeyOutputArgs, opts?: InvokeOptions): Output<GetAccessKeyResult>
    def get_access_key(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAccessKeyResult
def get_access_key_output(id: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAccessKeyResult]
    func LookupAccessKey(ctx *Context, args *LookupAccessKeyArgs, opts ...InvokeOption) (*LookupAccessKeyResult, error)
func LookupAccessKeyOutput(ctx *Context, args *LookupAccessKeyOutputArgs, opts ...InvokeOption) LookupAccessKeyResultOutput

    > Note: This function is named LookupAccessKey in the Go SDK.

    public static class GetAccessKey 
{
    public static Task<GetAccessKeyResult> InvokeAsync(GetAccessKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessKeyResult> Invoke(GetAccessKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAccessKeyResult> getAccessKey(GetAccessKeyArgs args, InvokeOptions options)
public static Output<GetAccessKeyResult> getAccessKey(GetAccessKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:rocketmq/getAccessKey:getAccessKey
  arguments:
    # arguments dictionary
    data "volcenginecc_rocketmq_get_access_key" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getAccessKey Result

    The following output properties are available:

    AccessKey string
    AccessKey ID for the RocketMQ key
    AclConfigJson string
    All ACL configuration information for the RocketMQ key
    Actived bool
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    AllAuthority string
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    CreateTime string
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    Description string
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    SecretKey string
    RocketMQ key. Returned only after creation
    TopicPermissions List<Volcengine.GetAccessKeyTopicPermission>
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    AccessKey string
    AccessKey ID for the RocketMQ key
    AclConfigJson string
    All ACL configuration information for the RocketMQ key
    Actived bool
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    AllAuthority string
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    CreateTime string
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    Description string
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    SecretKey string
    RocketMQ key. Returned only after creation
    TopicPermissions []GetAccessKeyTopicPermission
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    access_key string
    AccessKey ID for the RocketMQ key
    acl_config_json string
    All ACL configuration information for the RocketMQ key
    actived bool
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    all_authority string
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    create_time string
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    description string
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    id string
    Uniquely identifies the resource.
    instance_id string
    Instance ID
    secret_key string
    RocketMQ key. Returned only after creation
    topic_permissions list(object)
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    accessKey String
    AccessKey ID for the RocketMQ key
    aclConfigJson String
    All ACL configuration information for the RocketMQ key
    actived Boolean
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    allAuthority String
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    createTime String
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    description String
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    secretKey String
    RocketMQ key. Returned only after creation
    topicPermissions List<GetAccessKeyTopicPermission>
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    accessKey string
    AccessKey ID for the RocketMQ key
    aclConfigJson string
    All ACL configuration information for the RocketMQ key
    actived boolean
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    allAuthority string
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    createTime string
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    description string
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    secretKey string
    RocketMQ key. Returned only after creation
    topicPermissions GetAccessKeyTopicPermission[]
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    access_key str
    AccessKey ID for the RocketMQ key
    acl_config_json str
    All ACL configuration information for the RocketMQ key
    actived bool
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    all_authority str
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    create_time str
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    description str
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    secret_key str
    RocketMQ key. Returned only after creation
    topic_permissions Sequence[GetAccessKeyTopicPermission]
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null
    accessKey String
    AccessKey ID for the RocketMQ key
    aclConfigJson String
    All ACL configuration information for the RocketMQ key
    actived Boolean
    Enable status for the RocketMQ key. - true: Enabled - false: Not enabled
    allAuthority String
    Default permissions for the RocketMQ key. - ALL: Publish and subscribe permissions - PUB: Publish permission - SUB: Subscribe permission - DENY: No publish or subscribe permissions
    createTime String
    Creation time for the RocketMQ key. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'
    description String
    Description for the RocketMQ key, used to distinguish and manage keys effectively. Length limit: 0–128 characters
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    secretKey String
    RocketMQ key. Returned only after creation
    topicPermissions List<Property Map>
    Custom permissions for the key. Sets the permissions this AccessKey has for a specific Topic. If there are no custom permissions, displays as null

    Supporting Types

    GetAccessKeyTopicPermission

    Permission string
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    TopicName string
    Topic name
    Permission string
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    TopicName string
    Topic name
    permission string
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    topic_name string
    Topic name
    permission String
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    topicName String
    Topic name
    permission string
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    topicName string
    Topic name
    permission str
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    topic_name str
    Topic name
    permission String
    Permission type. AccessKey has permissions for this Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions
    topicName String
    Topic name

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.50
    published on Monday, Jul 20, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial