actiontrail¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.actiontrail.AwaitableGetConsumerGroupsResult(consumer_id_regex=None, consumer_ids=None, id=None, instance_id=None, output_file=None)¶

class pulumi_alicloud.actiontrail.AwaitableGetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.actiontrail.AwaitableGetSaslAclsResult(acl_resource_name=None, acl_resource_type=None, acls=None, id=None, instance_id=None, output_file=None, username=None)¶

class pulumi_alicloud.actiontrail.AwaitableGetSaslUsersResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, users=None)¶

class pulumi_alicloud.actiontrail.AwaitableGetTopicsResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, topics=None)¶

class pulumi_alicloud.actiontrail.AwaitableGetTrailsResult(actiontrails=None, id=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.actiontrail.GetConsumerGroupsResult(consumer_id_regex=None, consumer_ids=None, id=None, instance_id=None, output_file=None)¶

A collection of values returned by getConsumerGroups.

consumer_ids = None¶

A list of consumer group ids.

id = None¶

The provider-assigned unique ID for this managed resource.

class pulumi_alicloud.actiontrail.GetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getInstances.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of instance IDs.

instances = None¶

A list of instances. Each element contains the following attributes:

names = None¶

A list of instance names.

class pulumi_alicloud.actiontrail.GetSaslAclsResult(acl_resource_name=None, acl_resource_type=None, acls=None, id=None, instance_id=None, output_file=None, username=None)¶

A collection of values returned by getSaslAcls.

acl_resource_name = None¶

The resource name of the sasl acl.

acl_resource_type = None¶

The resource type of the sasl acl.

acls = None¶

A list of sasl acls. Each element contains the following attributes:

id = None¶

The provider-assigned unique ID for this managed resource.

username = None¶

The username of the sasl acl.

class pulumi_alicloud.actiontrail.GetSaslUsersResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, users=None)¶

A collection of values returned by getSaslUsers.

id = None¶

The provider-assigned unique ID for this managed resource.

names = None¶

A list of sasl usernames.

users = None¶

A list of sasl users. Each element contains the following attributes:

class pulumi_alicloud.actiontrail.GetTopicsResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, topics=None)¶

A collection of values returned by getTopics.

id = None¶

The provider-assigned unique ID for this managed resource.

names = None¶

A list of topic names.

topics = None¶

A list of topics. Each element contains the following attributes:

class pulumi_alicloud.actiontrail.GetTrailsResult(actiontrails=None, id=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getTrails.

actiontrails = None¶

A list of actiontrails. Each element contains the following attributes:

id = None¶

The provider-assigned unique ID for this managed resource.

names = None¶

A list of trail names.

class pulumi_alicloud.actiontrail.Trail(resource_name, opts=None, event_rw=None, name=None, oss_bucket_name=None, oss_key_prefix=None, role_name=None, sls_project_arn=None, sls_write_role_arn=None, __props__=None, __name__=None, __opts__=None)¶

Provides a new resource to manage Action Trail.

NOTE: Available in 1.35.0+

import pulumi
import pulumi_alicloud as alicloud

# Create a new action trail.
foo = alicloud.actiontrail.Trail("foo",
    event_rw="Write-test",
    oss_bucket_name=alicloud_oss_bucket["bucket"]["id"],
    oss_key_prefix="at-product-account-audit-B",
    role_name=alicloud_ram_role_policy_attachment["attach"]["role_name"])

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• event_rw (pulumi.Input[str]) – Indicates whether the event is a read or a write event. Valid values: Read, Write, and All. Default value: Write.

• name (pulumi.Input[str]) – The name of the trail to be created, which must be unique for an account.

• oss_bucket_name (pulumi.Input[str]) – The OSS bucket to which the trail delivers logs. Ensure that this is an existing OSS bucket.

• oss_key_prefix (pulumi.Input[str]) – The prefix of the specified OSS bucket name. This parameter can be left empty.

• role_name (pulumi.Input[str]) – The RAM role in ActionTrail permitted by the user.

• sls_project_arn (pulumi.Input[str]) – The unique ARN of the Log Service project.

• sls_write_role_arn (pulumi.Input[str]) – The unique ARN of the Log Service role.

event_rw: pulumi.Output[str] = None¶

Indicates whether the event is a read or a write event. Valid values: Read, Write, and All. Default value: Write.

name: pulumi.Output[str] = None¶

The name of the trail to be created, which must be unique for an account.

oss_bucket_name: pulumi.Output[str] = None¶

The OSS bucket to which the trail delivers logs. Ensure that this is an existing OSS bucket.

oss_key_prefix: pulumi.Output[str] = None¶

The prefix of the specified OSS bucket name. This parameter can be left empty.

role_name: pulumi.Output[str] = None¶

The RAM role in ActionTrail permitted by the user.

sls_project_arn: pulumi.Output[str] = None¶

The unique ARN of the Log Service project.

sls_write_role_arn: pulumi.Output[str] = None¶

The unique ARN of the Log Service role.

static get(resource_name, id, opts=None, event_rw=None, name=None, oss_bucket_name=None, oss_key_prefix=None, role_name=None, sls_project_arn=None, sls_write_role_arn=None)¶

Get an existing Trail resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• event_rw (pulumi.Input[str]) – Indicates whether the event is a read or a write event. Valid values: Read, Write, and All. Default value: Write.

• name (pulumi.Input[str]) – The name of the trail to be created, which must be unique for an account.

• oss_bucket_name (pulumi.Input[str]) – The OSS bucket to which the trail delivers logs. Ensure that this is an existing OSS bucket.

• oss_key_prefix (pulumi.Input[str]) – The prefix of the specified OSS bucket name. This parameter can be left empty.

• role_name (pulumi.Input[str]) – The RAM role in ActionTrail permitted by the user.

• sls_project_arn (pulumi.Input[str]) – The unique ARN of the Log Service project.

• sls_write_role_arn (pulumi.Input[str]) – The unique ARN of the Log Service role.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_alicloud.actiontrail.get_consumer_groups(consumer_id_regex=None, instance_id=None, output_file=None, opts=None)¶

This data source provides a list of ALIKAFKA Consumer Groups in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.56.0+

import pulumi
import pulumi_alicloud as alicloud

consumer_groups_ds = alicloud.actiontrail.get_consumer_groups(consumer_id_regex="CID-alikafkaGroupDatasourceName",
    instance_id="xxx",
    output_file="consumerGroups.txt")
pulumi.export("firstGroupName", consumer_groups_ds.consumer_ids[0])

Parameters

• consumer_id_regex (str) – A regex string to filter results by the consumer group id.

• instance_id (str) – ID of the ALIKAFKA Instance that owns the consumer groups.

pulumi_alicloud.actiontrail.get_instances(ids=None, name_regex=None, output_file=None, opts=None)¶

This data source provides a list of ALIKAFKA Instances in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.59.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
instance_name = config.get("instanceName")
if instance_name is None:
    instance_name = "alikafkaInstanceName"
default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="4",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)
instances_ds = alicloud.actiontrail.get_instances(name_regex="alikafkaInstanceName",
    output_file="instances.txt")
pulumi.export("firstInstanceName", instances_ds.instances[0]["name"])

Parameters

• ids (list) – A list of instance IDs to filter results.

• name_regex (str) – A regex string to filter results by the instance name.

pulumi_alicloud.actiontrail.get_sasl_acls(acl_resource_name=None, acl_resource_type=None, instance_id=None, output_file=None, username=None, opts=None)¶

This data source provides a list of ALIKAFKA Sasl acls in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.66.0+

import pulumi
import pulumi_alicloud as alicloud

sasl_acls_ds = alicloud.actiontrail.get_sasl_acls(acl_resource_name="testTopic",
    acl_resource_type="Topic",
    instance_id="xxx",
    output_file="saslAcls.txt",
    username="username")
pulumi.export("firstSaslAclUsername", sasl_acls_ds.acls[0]["username"])

Parameters

• acl_resource_name (str) – Get results for the specified resource name.

• acl_resource_type (str) – Get results for the specified resource type.

• instance_id (str) – ID of the ALIKAFKA Instance that owns the sasl acls.

• username (str) – Get results for the specified username.

pulumi_alicloud.actiontrail.get_sasl_users(instance_id=None, name_regex=None, output_file=None, opts=None)¶

This data source provides a list of ALIKAFKA Sasl users in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.66.0+

import pulumi
import pulumi_alicloud as alicloud

sasl_users_ds = alicloud.actiontrail.get_sasl_users(instance_id="xxx",
    name_regex="username",
    output_file="saslUsers.txt")
pulumi.export("firstSaslUsername", sasl_users_ds.users[0]["username"])

Parameters

• instance_id (str) – ID of the ALIKAFKA Instance that owns the sasl users.

• name_regex (str) – A regex string to filter results by the username.

pulumi_alicloud.actiontrail.get_topics(instance_id=None, name_regex=None, output_file=None, opts=None)¶

This data source provides a list of ALIKAFKA Topics in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.56.0+

import pulumi
import pulumi_alicloud as alicloud

topics_ds = alicloud.actiontrail.get_topics(instance_id="xxx",
    name_regex="alikafkaTopicName",
    output_file="topics.txt")
pulumi.export("firstTopicName", topics_ds.topics[0]["topic"])

Parameters

name_regex (str) – A regex string to filter results by the topic name.

pulumi_alicloud.actiontrail.get_trails(name_regex=None, output_file=None, opts=None)¶

This data source provides a list of action trail of the current Alibaba Cloud user.

import pulumi
import pulumi_alicloud as alicloud

trails = alicloud.actiontrail.get_trails(name_regex="tf-testacc-actiontrail")
pulumi.export("firstTrailName", trails.actiontrails[0]["name"])

Parameters

name_regex (str) – A regex string to filter results action trail name.