Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. cfg
  5. DeliveryChannel
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.cfg.DeliveryChannel

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

    Example Usage

    Create DeliveryChannel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DeliveryChannel(name: string, args: DeliveryChannelArgs, opts?: CustomResourceOptions);
    @overload
def DeliveryChannel(resource_name: str,
                    args: DeliveryChannelArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DeliveryChannel(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    delivery_channel_assume_role_arn: Optional[str] = None,
                    delivery_channel_target_arn: Optional[str] = None,
                    delivery_channel_type: Optional[str] = None,
                    delivery_channel_condition: Optional[str] = None,
                    delivery_channel_name: Optional[str] = None,
                    description: Optional[str] = None,
                    status: Optional[int] = None)
    func NewDeliveryChannel(ctx *Context, name string, args DeliveryChannelArgs, opts ...ResourceOption) (*DeliveryChannel, error)
    public DeliveryChannel(string name, DeliveryChannelArgs args, CustomResourceOptions? opts = null)
    public DeliveryChannel(String name, DeliveryChannelArgs args)
public DeliveryChannel(String name, DeliveryChannelArgs args, CustomResourceOptions options)

    type: alicloud:cfg:DeliveryChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DeliveryChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeliveryChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeliveryChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeliveryChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeliveryChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var deliveryChannelResource = new AliCloud.Cfg.DeliveryChannel("deliveryChannelResource", new()
{
    DeliveryChannelAssumeRoleArn = "string",
    DeliveryChannelTargetArn = "string",
    DeliveryChannelType = "string",
    DeliveryChannelCondition = "string",
    DeliveryChannelName = "string",
    Description = "string",
    Status = 0,
});

    example, err := cfg.NewDeliveryChannel(ctx, "deliveryChannelResource", &cfg.DeliveryChannelArgs{
	DeliveryChannelAssumeRoleArn: pulumi.String("string"),
	DeliveryChannelTargetArn:     pulumi.String("string"),
	DeliveryChannelType:          pulumi.String("string"),
	DeliveryChannelCondition:     pulumi.String("string"),
	DeliveryChannelName:          pulumi.String("string"),
	Description:                  pulumi.String("string"),
	Status:                       pulumi.Int(0),
})

    var deliveryChannelResource = new DeliveryChannel("deliveryChannelResource", DeliveryChannelArgs.builder()
    .deliveryChannelAssumeRoleArn("string")
    .deliveryChannelTargetArn("string")
    .deliveryChannelType("string")
    .deliveryChannelCondition("string")
    .deliveryChannelName("string")
    .description("string")
    .status(0)
    .build());

    delivery_channel_resource = alicloud.cfg.DeliveryChannel("deliveryChannelResource",
    delivery_channel_assume_role_arn="string",
    delivery_channel_target_arn="string",
    delivery_channel_type="string",
    delivery_channel_condition="string",
    delivery_channel_name="string",
    description="string",
    status=0)

    const deliveryChannelResource = new alicloud.cfg.DeliveryChannel("deliveryChannelResource", {
    deliveryChannelAssumeRoleArn: "string",
    deliveryChannelTargetArn: "string",
    deliveryChannelType: "string",
    deliveryChannelCondition: "string",
    deliveryChannelName: "string",
    description: "string",
    status: 0,
});

    type: alicloud:cfg:DeliveryChannel
properties:
    deliveryChannelAssumeRoleArn: string
    deliveryChannelCondition: string
    deliveryChannelName: string
    deliveryChannelTargetArn: string
    deliveryChannelType: string
    description: string
    status: 0

    DeliveryChannel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DeliveryChannel resource accepts the following input properties:

    DeliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    DeliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    DeliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    DeliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    DeliveryChannelName string
    The name of the delivery channel.
    Description string
    The description of the delivery method.
    Status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    DeliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    DeliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    DeliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    DeliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    DeliveryChannelName string
    The name of the delivery channel.
    Description string
    The description of the delivery method.
    Status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn String
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelTargetArn String
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType String
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    deliveryChannelCondition String
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName String
    The name of the delivery channel.
    description String
    The description of the delivery method.
    status Integer
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    deliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName string
    The name of the delivery channel.
    description string
    The description of the delivery method.
    status number
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    delivery_channel_assume_role_arn str
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    delivery_channel_target_arn str
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    delivery_channel_type str
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    delivery_channel_condition str
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    delivery_channel_name str
    The name of the delivery channel.
    description str
    The description of the delivery method.
    status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn String
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelTargetArn String
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType String
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    deliveryChannelCondition String
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName String
    The name of the delivery channel.
    description String
    The description of the delivery method.
    status Number
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DeliveryChannel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DeliveryChannel Resource

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

    public static get(name: string, id: Input<ID>, state?: DeliveryChannelState, opts?: CustomResourceOptions): DeliveryChannel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delivery_channel_assume_role_arn: Optional[str] = None,
        delivery_channel_condition: Optional[str] = None,
        delivery_channel_name: Optional[str] = None,
        delivery_channel_target_arn: Optional[str] = None,
        delivery_channel_type: Optional[str] = None,
        description: Optional[str] = None,
        status: Optional[int] = None) -> DeliveryChannel
    func GetDeliveryChannel(ctx *Context, name string, id IDInput, state *DeliveryChannelState, opts ...ResourceOption) (*DeliveryChannel, error)
    public static DeliveryChannel Get(string name, Input<string> id, DeliveryChannelState? state, CustomResourceOptions? opts = null)
    public static DeliveryChannel get(String name, Output<String> id, DeliveryChannelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    DeliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    DeliveryChannelName string
    The name of the delivery channel.
    DeliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    DeliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    Description string
    The description of the delivery method.
    Status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    DeliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    DeliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    DeliveryChannelName string
    The name of the delivery channel.
    DeliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    DeliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    Description string
    The description of the delivery method.
    Status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn String
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelCondition String
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName String
    The name of the delivery channel.
    deliveryChannelTargetArn String
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType String
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    description String
    The description of the delivery method.
    status Integer
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn string
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelCondition string
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName string
    The name of the delivery channel.
    deliveryChannelTargetArn string
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType string
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    description string
    The description of the delivery method.
    status number
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    delivery_channel_assume_role_arn str
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    delivery_channel_condition str
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    delivery_channel_name str
    The name of the delivery channel.
    delivery_channel_target_arn str
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    delivery_channel_type str
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    description str
    The description of the delivery method.
    status int
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.
    deliveryChannelAssumeRoleArn String
    The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
    deliveryChannelCondition String
    The rule attached to the delivery method. This parameter is applicable only to delivery methods of the MNS type. Please refer to api PutDeliveryChannel for example format.
    deliveryChannelName String
    The name of the delivery channel.
    deliveryChannelTargetArn String
    The ARN of the delivery destination. This parameter is required when you create a delivery method. The value must be in one of the following formats:

    • acs:oss:{RegionId}:{Aliuid}:{bucketName}: if your delivery destination is an Object Storage Service (OSS) bucket.
    • acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}: if your delivery destination is a Message Service (MNS) topic.
    • acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}: if your delivery destination is a Log Service Logstore.
    deliveryChannelType String
    The type of the delivery method. This parameter is required when you create a delivery method. Valid values: OSS: Object Storage, MNS: Message Service, SLS: Log Service.
    description String
    The description of the delivery method.
    status Number
    The status of the delivery method. Valid values: 0: The delivery method is disabled., 1: The delivery destination is enabled. This is the default value.

    Import

    Alicloud Config Delivery Channel can be imported using the id, e.g.

    $ pulumi import alicloud:cfg/deliveryChannel:DeliveryChannel example cdc-49a2ad756057********

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud