Skip to main content

ClusterAgentToken

Resource ClusterAgentToken in pulumi-buildkite.
2 min read

Resource ClusterAgentToken in pulumi-buildkite.

Pulumi type: buildkite:index/clusterAgentToken:ClusterAgentToken.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
allowedIpAddressesstring[]noA list of CIDR-notation IPv4 addresses from which agents can use this Cluster Agent Token.If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
clusterIdstringyesThe GraphQL ID of the Cluster that this Cluster Agent Token belongs to.
descriptionstringyesA description about what this cluster agent token is used for.
expiresAtstringnoThe time at which the token expires, in RFC 3339 format with up to millisecond precision (e.g. 2030-01-01T00:00:00Z) and at least 10 minutes in the future. If not set, the token never expires. Changing this value replaces the token, since the expiry cannot be updated.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
allowedIpAddressesstring[]noA list of CIDR-notation IPv4 addresses from which agents can use this Cluster Agent Token.If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
clusterIdstringnoThe GraphQL ID of the Cluster that this Cluster Agent Token belongs to.
clusterUuidstringyesThe UUID of the Cluster that this token belongs to.
descriptionstringnoA description about what this cluster agent token is used for.
expiresAtstringnoThe time at which the token expires, in RFC 3339 format with up to millisecond precision (e.g. 2030-01-01T00:00:00Z) and at least 10 minutes in the future. If not set, the token never expires. Changing this value replaces the token, since the expiry cannot be updated.
tokenstringyesThe token value used by an agent to register with the API.
uuidstringyesThe UUID of the token.